@contrail/cli 3.6.0-alpha-7-alpha.d8f5a20 → 3.6.0-alpha-8-alpha.668a0d5

package/README.md

@@ -17,7 +17,7 @@ $ npm install -g @contrail/cli
 $ contrail COMMAND
 running command...
 $ contrail (--version)
-@contrail/cli/3.6.0-alpha-7-alpha.d8f5a20 linux-x64 node-v24.20.0
+@contrail/cli/3.6.0-alpha-8-alpha.668a0d5 linux-x64 node-v24.20.0
 $ contrail --help [COMMAND]
 USAGE
   $ contrail COMMAND

package/dist/commands/entities/delete.js

@@ -98,21 +98,7 @@ async function deleteEntityByIds(entityName, ids) {
 async function deleteEntityById(entityName, id) {
     const client = new sdk_1.Entities();
     if (IS_DRY_RUN) {
-        return client.get({ entityName, id }).catch(throwIfNot404);
+        return client.get({ entityName, id, ignore404: true });
     }
-    return client.delete({ entityName, id }).catch(throwIfNot404);
-}
-function throwIfNot404(e) {
-    const { statusCode } = parseSDKErrorMessage(e);
-    if (statusCode === 404) {
-        return null;
-    }
-    throw e;
-}
-function parseSDKErrorMessage(e) {
-    const parsed = JSON.parse(e.details);
-    return {
-        statusCode: parsed.statusCode,
-        message: parsed.message,
-    };
+    return client.delete({ entityName, id, ignore404: true });
 }

package/dist/commands/entities/get.js

@@ -183,7 +183,8 @@ async function find(entityName, options = {}) {
         return (0, batchFetch_1.batchFetch)(entityName, payload);
     }
     else {
-        return client.get(payload);
+        // Fetching by id can 404; return null for a missing entity instead of retrying and throwing
+        return client.get(id ? { ...payload, ignore404: true } : payload);
     }
 }
 async function* streamPaginatedFind(typePath, options = {}) {

package/node_modules/@contrail/org-config-migration/node_modules/@contrail/sdk/.github/pull_request_template.md

@@ -0,0 +1,31 @@
+## What
+
+- [ ] Bugfix
+- [ ] Feature
+- [ ] Enhancement
+
+Description:
+
+<!--
+Describe the functional changes of the PR.
+
+If the mechanism of your change are complex, describe them in detail as you
+would if you were explaining them to a team mate.
+
+If the PR is simple, there is no need to repeat yourself. A small description
+is sufficient.
+-->
+
+## Why
+
+<!--
+why is this change needed? Same rules as with #What
+ -->
+
+## Testing added
+
+<!--
+Describe the testing you added to this PR
+ -->
+
+## Link to Jira ticket(s)

package/node_modules/@contrail/org-config-migration/node_modules/@contrail/sdk/.github/workflows/check-code-formatting.yml

@@ -0,0 +1,34 @@
+name: Check Code Formatting
+on:
+  pull_request:
+    paths:
+      - '**'
+  workflow_dispatch: # allow running in github actions manually
+jobs:
+  check-formatting:
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+      - uses: actions/checkout@v3
+        with:
+          lfs: true
+      - name: Checkout LFS objects
+        run: git lfs checkout
+      - name: NPM Install
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npm ci
+      - name: Check Format
+        working-directory: ./
+        run: npx prettier --check .
+      - name: Fail On Warnings
+        run: |
+          if [ $? -eq 0 ]; then
+            echo "No formatting issues found"
+          else
+            echo "Formatting issues found. Run 'npx prettier --write .' to fix them."
+            exit 1
+          fi

package/node_modules/@contrail/org-config-migration/node_modules/@contrail/sdk/.github/workflows/empty.yml

@@ -0,0 +1,10 @@
+name: empty-passing-test
+on: pull_request
+jobs:
+  test:
+    runs-on: ubuntu-24.04
+    strategy:
+      matrix:
+        node-version: [16.17.0]
+    steps:
+      - run: 'echo "empty test for passing status checks"'

package/node_modules/@contrail/org-config-migration/node_modules/@contrail/sdk/.github/workflows/generate-sdk-docs.yml

@@ -0,0 +1,32 @@
+name: generate-sdk-docs
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - '**'
+  workflow_dispatch: # allow running in github actions manually
+jobs:
+  deploy-docs:
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.17.0
+
+      - uses: actions/checkout@v3
+
+      - name: NPM Install
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npm ci
+      - name: Build SDK Docs
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npm run generate-docs
+      - name: Deploy 🚀
+        uses: JamesIves/github-pages-deploy-action@4.1.4
+        with:
+          branch: gh-pages
+          folder: docs

package/node_modules/@contrail/org-config-migration/node_modules/@contrail/sdk/.github/workflows/publish-to-npm.yml

@@ -0,0 +1,117 @@
+name: Publish to NPM
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: ['**']
+
+jobs:
+  check-version:
+    name: Verify version is available on npm
+    if: github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Check version not already published
+        run: |
+          PACKAGE_NAME=$(node -p "require('./package.json').name")
+          VERSION=$(node -p "require('./package.json').version")
+          echo "Checking if ${PACKAGE_NAME}@${VERSION} exists on npm..."
+          if npm view "${PACKAGE_NAME}@${VERSION}" version 2>/dev/null; then
+            echo "::error::Version ${VERSION} is already published on npm. Bump the version in package.json before merging."
+            exit 1
+          else
+            echo "Version ${VERSION} is available."
+          fi
+
+  check-dependencies:
+    name: Verify no private dependencies
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Verify no private dependencies
+        run: |
+          node -e "
+            const deps = require('./package.json').dependencies || {};
+            const { execSync } = require('child_process');
+            let failed = false;
+            for (const pkg of Object.keys(deps)) {
+              try {
+                execSync('npm view ' + pkg, { stdio: 'pipe' });
+              } catch {
+                console.error('::error::Dependency ' + pkg + ' is not publicly accessible on npm');
+                failed = true;
+              }
+            }
+            if (failed) process.exit(1);
+            console.log('All ' + Object.keys(deps).length + ' dependencies are public.');
+          "
+
+  publish-alpha:
+    name: Publish alpha
+    needs: check-dependencies
+    if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: read
+    outputs:
+      version: ${{ steps.publish.outputs.version }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '24'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install and build
+        run: npm ci && npm run build
+
+      - name: Publish alpha
+        id: publish
+        run: |
+          SHORT_SHA=$(echo ${{ github.event.pull_request.head.sha }} | cut -c1-7)
+          VERSION=$(node -p "require('./package.json').version")-alpha.${SHORT_SHA}
+          npm version $VERSION --no-git-tag-version
+          OUTPUT=$(npm publish --tag alpha 2>&1) && {
+            echo "version=$VERSION" >> $GITHUB_OUTPUT
+          } || {
+            if echo "$OUTPUT" | grep -q "You cannot publish over the previously published versions"; then
+              echo "::warning::Alpha ${VERSION} already published, skipping."
+            else
+              echo "::error::Failed to publish alpha ${VERSION}"
+              echo "$OUTPUT"
+              exit 1
+            fi
+          }
+
+  publish-release:
+    name: Publish release
+    needs: check-dependencies
+    if: github.event_name == 'push'
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: read
+    outputs:
+      version: ${{ steps.publish.outputs.version }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '24'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install and build
+        run: npm ci && npm run build
+
+      - name: Publish release
+        id: publish
+        run: |
+          npm publish
+          echo "version=$(node -p "require('./package.json').version")" >> $GITHUB_OUTPUT

package/node_modules/@contrail/org-config-migration/node_modules/@contrail/sdk/.github/workflows/sdk-lib.yml

@@ -0,0 +1,27 @@
+name: sdk-lib-tests
+on:
+  pull_request:
+    # run this workflow when files these files change
+    paths:
+      - '**'
+  workflow_dispatch: # allow running in github actions manually
+jobs:
+  test:
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - uses: actions/checkout@v3
+
+      - name: NPM Install
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npm ci
+
+      - name: Unit Tests -
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npm test

package/node_modules/@contrail/org-config-migration/node_modules/@contrail/sdk/.prettierrc.yaml

@@ -0,0 +1,2 @@
+singleQuote: true
+printWidth: 120

package/node_modules/@contrail/org-config-migration/node_modules/@contrail/sdk/README.md

@@ -0,0 +1,72 @@
+# [Contrail SDK](https://archergreysorg.github.io/contrail-lib/)
+
+Functionality within the VibeIQ platform (Contrail) can be accessed and extended through a TypeScript SDK. The SDK is installable via the popular JavaScript Node Packages Manager `npm`.
+
+```bash
+npm install @contrail/sdk --global
+```
+
+This will install the contrail SDK globally to your system, which will enable you to use it in any script, regardless of which directory it is in.
+
+Alternatively, If you are using the SDK as part of a module you plan on packaging and sharing with other developers (or deploying to the cloud), you can add the SDK to your project:
+
+```bash
+npm install @contrail/sdk
+```
+
+### Scripting vs App development
+
+In the world of Javascript, code can be written as a one-off "script", run through the `node` interpreter, or packaged as part of an application. Below are examples on how to authenticate and print your username in each of these paradigms.
+
+#### Scripting
+
+To use the Contrail SDK as part of a one-off script, you can use the `require` javascript keyword.
+
+```js title="script.js"
+const contrail = require('@contrail/sdk');
+
+// define an asynchronous function
+const run = async () => {
+  await contrail.login({ orgSlug: 'YOUR-ORG-HERE', email: 'myEmail@example.com', password: 'neverInPlainText' });
+
+  // or using an api key like the one you can get from `contrail app getApiKey`
+  // await contrail.login({orgSlug: 'test-zone-1', apiKey: 'app:qwerty'})
+
+  const user = await contrail.getCurrentUser();
+  console.log('USER:', JSON.stringify(user, null, 2));
+};
+
+// run the function
+run();
+```
+
+You can run your script using `node` in your shell.
+
+```shell
+node script.js
+```
+
+#### Packaged Module
+
+If you intend on using the Contrail SDK as part of your packaging module, you may use the `import` keyword. You are more likely to use this when writing integrations as part of a web or server runtime.
+
+```js title="someServerFile.js"
+import { login, getCurrentUser } from '@contrail/sdk';
+
+export async function run() {
+  await login({ orgSlug: 'YOUR-ORG-HERE', email: 'myEmail@example.com', password: 'neverInPlainText' });
+
+  // or using an api key like the one you can get from `contrail app getApiKey`
+  // await login({orgSlug: 'test-zone-1', apiKey: 'app:qwerty'})
+
+  const user = await getCurrentUser();
+  console.log('USER:', JSON.stringify(user, null, 2));
+}
+
+// run the function
+run();
+```
+
+# General Documentation
+
+Complete documentation for the VibeIQ platform lives on [https://docs.vibeiq.com/](https://docs.vibeiq.com/).

package/node_modules/@contrail/org-config-migration/node_modules/@contrail/sdk/home-hero.svg

@@ -0,0 +1,11 @@
+<svg width="635" height="433" viewBox="0 0 635 433" fill="none" xmlns="http://www.w3.org/2000/svg">
+<g clip-path="url(#clip0_309_15692)">
+<path d="M656.604 384.076C457.662 384.076 414.538 48.9114 216.574 48.9114C172.144 48.9339 129.54 66.5999 98.1308 98.0252C66.7213 129.451 49.077 172.063 49.077 216.494" stroke="#202532" stroke-width="97.8221" stroke-miterlimit="10"/>
+<path d="M49.077 216.494C49.077 309.04 128.454 384.076 216.66 384.076C415.601 384.076 457.747 48.9114 656.689 48.9114C701.134 48.9114 743.76 66.5673 775.188 97.9952C806.615 129.423 824.272 172.048 824.272 216.494C824.272 260.94 806.615 303.565 775.188 334.993C743.76 366.421 701.134 384.076 656.689 384.076" stroke="#00ABE9" stroke-width="97.8221" stroke-miterlimit="10"/>
+</g>
+<defs>
+<clipPath id="clip0_309_15692">
+<rect width="873.016" height="432.987" fill="white" transform="translate(0.166809)"/>
+</clipPath>
+</defs>
+</svg>

package/node_modules/@contrail/org-config-migration/node_modules/@contrail/sdk/lib/assets/assets.d.ts

@@ -0,0 +1,9 @@
+export interface CreateAssetOptions {
+    file?: File;
+    contentHolderReference?: string;
+    fileId?: string;
+    workspaceId?: string;
+}
+export declare class Assets {
+    create(options: CreateAssetOptions): Promise<any>;
+}

package/node_modules/@contrail/org-config-migration/node_modules/@contrail/sdk/lib/assets/assets.js

@@ -0,0 +1,54 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Assets = void 0;
+const entities_1 = require("../entities");
+const file_type_helper_1 = require("../files/file-type-helper");
+const files_1 = require("../files/files");
+class Assets {
+    create(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let asset = null;
+            if (options.file) {
+                const file = options.file;
+                if (!file) {
+                    throw Error(`Must specify file in create.`);
+                }
+                const contentType = file.type || file_type_helper_1.FileTypeHelper.getContentType(file);
+                asset = yield new entities_1.Entities().create({
+                    entityName: 'asset',
+                    object: {
+                        contentHolderReference: options.contentHolderReference,
+                        fileName: file.name,
+                        contentType,
+                        workspaceId: options.workspaceId,
+                    },
+                });
+                yield new files_1.Files().uploadFile(asset.content.primaryFile.uploadPost, file);
+            }
+            else if (options.fileId) {
+                asset = yield new entities_1.Entities().create({
+                    entityName: 'asset',
+                    object: {
+                        contentHolderReference: options.contentHolderReference,
+                        copyFileId: options.fileId,
+                        workspaceId: options.workspaceId,
+                    },
+                });
+            }
+            else {
+                throw new Error('Must specify file or fileId');
+            }
+            return asset;
+        });
+    }
+}
+exports.Assets = Assets;

package/node_modules/@contrail/org-config-migration/node_modules/@contrail/sdk/lib/assets/index.d.ts

@@ -0,0 +1 @@
+export * from './assets';

package/node_modules/@contrail/org-config-migration/node_modules/@contrail/sdk/lib/assets/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./assets"), exports);

package/node_modules/@contrail/org-config-migration/node_modules/@contrail/sdk/lib/auth/auth.d.ts

@@ -0,0 +1,10 @@
+export interface AuthContext {
+    apiUserToken: string;
+    apiRefreshToken?: string;
+    apiGateway?: string;
+    orgSlug?: string;
+    orgId?: string;
+}
+export declare class Auth {
+    static config: AuthContext;
+}

package/node_modules/@contrail/org-config-migration/node_modules/@contrail/sdk/lib/auth/auth.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Auth = void 0;
+class Auth {
+}
+exports.Auth = Auth;

package/node_modules/@contrail/org-config-migration/node_modules/@contrail/sdk/lib/auth/index.d.ts

@@ -0,0 +1,2 @@
+export * from './login';
+export * from './auth';

package/node_modules/@contrail/org-config-migration/node_modules/@contrail/sdk/lib/auth/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./login"), exports);
+__exportStar(require("./auth"), exports);

package/node_modules/@contrail/org-config-migration/node_modules/@contrail/sdk/lib/auth/login.d.ts

@@ -0,0 +1,10 @@
+import { AuthContext } from './auth';
+export interface LoginCredentials {
+    orgSlug: string;
+    email?: string;
+    password?: string;
+    apiKey?: string;
+}
+export declare function setAppCredentials(apiKey: string, orgSlug: string): Promise<AuthContext>;
+export declare function login(credentials: LoginCredentials): Promise<AuthContext>;
+export declare function getCurrentUser(): Promise<any>;