feat: 0.19.0

.commitlintrc.js → .commitlintrc.cjs

@@ -1,34 +1,34 @@
-/**
- * @type {import('@commitlint/types').UserConfig}
- */
-module.exports = {
-    extends: ['@commitlint/config-conventional'],
-
-    rules: {
-        'scope-enum': [
-            2,
-            'always',
-            [
-                'attributes', // guarding and casting can also go under attributes
-                'global-config',
-                'exception',
-                'events',
-                'services',
-                'helpers',
-                'collection',
-                'model',
-                'model-collection',
-                'ancestry-collection',
-                'paginator',
-                'factory',
-                'query-builder',
-                'timestamps', // soft-deletes can also go under timestamps
-                'relations',
-                'api-calls',
-                'deps',
-                'deps-dev',
-                'internal' // things that are not meant to be used outside the package
-            ]
-        ],
-    }
-};
+/**
+ * @type {import('@commitlint/types').UserConfig}
+ */
+module.exports = {
+    extends: ['@commitlint/config-conventional'],
+
+    rules: {
+        'scope-enum': [
+            2,
+            'always',
+            [
+                'attributes', // guarding and casting can also go under attributes
+                'global-config',
+                'exception',
+                'events',
+                'services',
+                'helpers',
+                'collection',
+                'model',
+                'model-collection',
+                'ancestry-collection',
+                'paginator',
+                'factory',
+                'query-builder',
+                'timestamps', // soft-deletes can also go under timestamps
+                'relations',
+                'api-calls',
+                'deps',
+                'deps-dev',
+                'internal' // things that are not meant to be used outside the package
+            ]
+        ],
+    }
+};

.github/workflows/build.yml

@@ -21,8 +21,8 @@ jobs:
       group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
       cancel-in-progress: true
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v5
+      - uses: actions/setup-node@v5
         with:
           cache: 'npm'
       - name: Install dependencies

.github/workflows/deploy-api-docs.yml

@@ -12,8 +12,8 @@ jobs:
     timeout-minutes: 10
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v5
+      - uses: actions/setup-node@v5
         with:
           cache: 'npm'
       - name: Install dependencies

.github/workflows/lint.yml

@@ -18,8 +18,8 @@ jobs:
       group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
       cancel-in-progress: true
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v5
+      - uses: actions/setup-node@v5
         with:
           cache: 'npm'
       - name: Install dependencies

.github/workflows/release.yml

@@ -38,20 +38,23 @@ jobs:
   publish:
     timeout-minutes: 10
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v5
+      - uses: actions/setup-node@v5
         with:
           registry-url: https://registry.npmjs.org/
       - name: Install dependencies
         run: npm ci --ignore-scripts
       - name: Build library
         run: npm run build
       - name: Publish library
-        run: npm publish --access public
+        run: npm publish --provenance --access public
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v5
         with:
           registry-url: https://npm.pkg.github.com/
       - run: npm publish --access public

.github/workflows/test.yml

@@ -7,7 +7,6 @@ on:
       - '**/tsconfig.json'
       - 'tests/**/*.ts'
       - 'src/**/*.ts'
-      - 'jest.config.ts'
       - 'package-lock.json'
     branches:
       - main
@@ -21,37 +20,54 @@ jobs:
       group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
       cancel-in-progress: true
     steps:
-      # subsequent calls to this action will use already downloaded code from the workspace
-      - uses: actions/checkout@v3
-  jest-browser:
+      - uses: actions/checkout@v5
+  test-browser:
     needs: setup-test
     timeout-minutes: 10
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v5
+      - uses: actions/setup-node@v5
         with:
+          node-version: 'lts/*'
           cache: 'npm'
-          node-version: 'latest'
       - name: Install dependencies
-        run: npm ci --ignore-scripts
+        run: npm ci
       - name: Run tests on jsdom
-        run: npx jest --selectProjects=jsdom
-  jest-node:
+        run: npm run test -- --environment=jsdom
+  test-node:
     needs: setup-test
     timeout-minutes: 10
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        # current and active LTS
-        node: [ 18, 20 ]
+        node: ['lts/*', 'current']
+      fail-fast: false
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v5
+      - uses: actions/setup-node@v5
         with:
+          node-version: ${{ matrix.node }}
           cache: 'npm'
+      - name: Install dependencies
+        run: npm ci
+      - name: Run tests on node ${{ matrix.node }}
+        run: npm run test
+  test-edge:
+    needs: setup-test
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node: ['lts/*', 'current']
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-node@v5
+        with:
           node-version: ${{ matrix.node }}
+          cache: 'npm'
       - name: Install dependencies
-        run: npm ci --ignore-scripts
-      - name: Run tests on node v${{ matrix.node }}
-        run: npx jest --selectProjects=node
+        run: npm ci
+      - name: Run tests on node ${{ matrix.node }}
+        run: npm run test -- --environment edge-runtime

.gitignore

@@ -4,7 +4,9 @@ index.*.*js*
 array.*.*js*
 string.*.*js*
 types
+/Support
 *.tgz
+tslib.es6-*
 
 # in case gh-pages manually managed
 index.html

build.tsconfig.json

@@ -0,0 +1,6 @@
+{
+    "extends": "./tsconfig.json",
+    "include": [
+        "src/*.ts"
+    ]
+}

docs/.vuepress/links.ts

@@ -67,7 +67,7 @@ const sidebar: SidebarConfig = [
 ]
 
 const navbar: NavbarConfig = [
-    { text: 'API', link: 'https://upfrontjs.github.io/framework', target:'_blank' }
+    { text: 'API', link: 'https://api.upfrontjs.com/framework', target:'_blank' }
 ]
 
 export default {

docs/helpers/readme.md

@@ -459,6 +459,39 @@ value(
 ); // 2
 ```
 
+#### poll
+
+The `poll` method repeatedly executes a promise function until a specified condition is met. It's useful for polling operations where you need to wait for a resource to become available or reach a desired state. The function takes 3 arguments:
+ - `fn` - The function returning a promise to be called repeatedly
+ - `wait` (default: 0) - The wait time between attempts in milliseconds. If 0, it will not wait between attempts. If a function, it will be called with the result and attempt count.
+ - `until` - The condition to stop polling. If a Date, polling stops when that time is reached. If a function, it receives the result and attempt count and should return true to stop.
+
+```ts
+import { poll } from '@upfrontjs/framework';
+
+// Poll an API endpoint every 1000ms until a specific condition is met
+const result = await poll(
+  () => fetch('/api/status').then(r => r.json()),
+  1000,
+  (data) => data.status === 'complete'
+);
+
+// Poll with dynamic wait time based on attempts
+const result = await poll(
+  () => checkResource(),
+  (result, attempts) => Math.min(1000 * attempts, 10000), // exponential backoff with cap
+  (result) => result.ready
+);
+
+// Poll until a specific time
+const timeoutDate = new Date(Date.now() + 30000); // 30 seconds from now
+const result = await poll(
+  () => performCheck(),
+  500,
+  timeoutDate
+);
+```
+
 #### dataGet
 
 The `dataGet` is a helper method to safely access any path within an object or array. If the path does not exist, it will return the default value (default: `undefined`). Optionally the path may include a wildcard `*` to match array elements.

docs/testing/readme.md

@@ -17,7 +17,7 @@ import User from '@/Models'
 const config = new GlobalConfig;
 
 describe('customAjaxMethod()', () => {
-    const mockFunc = jest.fn();
+    const mockFunc = vi.fn();
     const user = new User;
     config.set('api', {
         handle: mockFunc
@@ -43,7 +43,7 @@ import User from '@/Models/User'
 const config: GlobalConfig<MyConfig extends Configuration> = new GlobalConfig;
 
 describe('customAjaxMethod()', () => {
-    const mockFunc = jest.fn();
+    const mockFunc = vi.fn();
     const user = new User;
     config.set('api', {
         handle: mockFunc