@contrail/cli 3.4.0-alpha → 3.4.0

package/dist/helpers/types/type-uploader.spec.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const type_uploader_1 = require("./type-uploader");
+const login_1 = require("../../auth/login");
+const sdk_1 = require("../../__mocks__/@contrail/sdk");
+jest.mock('../../auth/login');
 describe('extractValueDifferences', () => {
     it('should return the correct value differences', () => {
         const object1 = {
@@ -117,3 +120,506 @@ describe('extractValueDifferences', () => {
         expect(valueDiff).toEqual(expectedValueDiff);
     });
 });
+describe('uploadTypes', () => {
+    let updateSpy;
+    let createSpy;
+    let requestSpy;
+    let fsSpy;
+    let authUserMock;
+    beforeEach(() => {
+        // Mock authUser
+        authUserMock = login_1.authUser;
+        authUserMock.mockResolvedValue({ orgSlug: 'test-org' });
+        const sdk = require('@contrail/sdk');
+        updateSpy = jest.spyOn(sdk.Entities.prototype, 'update');
+        createSpy = jest.spyOn(sdk.Entities.prototype, 'create');
+        // Mock Request.request as a function
+        sdk.Request = { request: jest.fn() };
+        requestSpy = sdk.Request.request;
+        // Mock filesystem operations
+        jest.spyOn(require('fs'), 'readdirSync').mockReturnValue(['color.yml']);
+        fsSpy = jest.spyOn(require('fs'), 'readFileSync');
+        fsSpy.mockReturnValue(FULL_TYPE_YML);
+    });
+    afterEach(() => {
+        jest.restoreAllMocks();
+    });
+    it('should fully re-populate type and its properties when not merging', async () => {
+        fsSpy.mockReturnValue(FULL_TYPE_YML);
+        await (0, type_uploader_1.uploadTypes)('mock-dir', { isMerge: false });
+        const nonCoreTypePropertiesCount = sdk_1.BASE_TYPE_WITH_PROPERTIES.typeProperties.filter((prop) => !prop.core).length;
+        expect(updateSpy).toHaveBeenCalledTimes(nonCoreTypePropertiesCount + 1); // +1 for the type update
+        expect(requestSpy).toHaveBeenCalledTimes(0);
+        expect(createSpy).toHaveBeenCalledTimes(0);
+    });
+    it('should modify property "label" on type only', async () => {
+        fsSpy.mockReturnValue(TYPE_WITH_UPDATED_LABEL_YML);
+        await (0, type_uploader_1.uploadTypes)('mock-dir', { isMerge: true });
+        expect(requestSpy).toHaveBeenCalledTimes(0);
+        expect(createSpy).toHaveBeenCalledTimes(0);
+        expect(updateSpy).toHaveBeenCalledTimes(1);
+        expect(updateSpy).toHaveBeenCalledWith(expect.objectContaining({
+            entityName: 'type',
+            object: {
+                typePath: 'color',
+                label: 'Color 2',
+            },
+        }));
+    });
+    it('should update type-property on existing type only', async () => {
+        fsSpy.mockReturnValue(TYPE_WITH_UPDATED_PROPERTY_YML);
+        await (0, type_uploader_1.uploadTypes)('mock-dir', { isMerge: true });
+        expect(requestSpy).toHaveBeenCalledTimes(0);
+        expect(createSpy).toHaveBeenCalledTimes(0);
+        expect(updateSpy).toHaveBeenCalledTimes(1);
+        expect(updateSpy).toHaveBeenCalledWith(expect.objectContaining({
+            entityName: 'type-property',
+            object: {
+                slug: 'rgb',
+                isArchived: true,
+                typePropertyUserListId: null,
+            },
+        }));
+    });
+    it('should add new type-property to existing type', async () => {
+        fsSpy.mockReturnValue(TYPE_WITH_NEW_PROPERTY_YML);
+        await (0, type_uploader_1.uploadTypes)('mock-dir', { isMerge: true });
+        expect(createSpy).toHaveBeenCalledTimes(0);
+        expect(updateSpy).toHaveBeenCalledTimes(0);
+        expect(requestSpy).toHaveBeenCalledTimes(1);
+        expect(requestSpy).toHaveBeenCalledWith(expect.stringMatching(/^\/types\/[^/]+\/type-properties$/), expect.objectContaining({
+            method: 'POST',
+            body: JSON.stringify({
+                isArchived: false,
+                propertyType: 'number',
+                slug: 'code',
+                label: 'Code',
+                editable: true,
+                searchable: false,
+                core: false,
+                formula: null,
+                referencedTypePath: null,
+                carryOverBehavior: null,
+                carryOverDefault: null,
+                referencedTypeRootSlug: null,
+                defaultValue: null,
+                typePropertyUserListId: null,
+                referencedTypeRole: null,
+                isUniqueProperty: false,
+                isUniquePropertyInFamily: false,
+                propertyLevel: null,
+                formulaFunction: null,
+                validationFunction: null,
+                numberFormat: null,
+                sequenceSeedValue: null,
+            }),
+        }));
+    });
+    it('should create new subtype with property', async () => {
+        fsSpy.mockReturnValue(SUBTYPE_WITH_PROPERTY_YML);
+        await (0, type_uploader_1.uploadTypes)('mock-dir', { isMerge: true });
+        expect(updateSpy).toHaveBeenCalledTimes(0);
+        expect(createSpy).toHaveBeenCalledTimes(1);
+        expect(createSpy).toHaveBeenCalledWith(expect.objectContaining({
+            entityName: 'type',
+            object: {
+                slug: 'test-subtype',
+                label: 'Color Test Subtype',
+                typePath: 'color:test-subtype',
+                isArchived: false,
+            },
+        }));
+        expect(requestSpy).toHaveBeenCalledTimes(1);
+        expect(requestSpy).toHaveBeenCalledWith(expect.stringMatching(/^\/types\/[^/]+\/type-properties$/), expect.objectContaining({
+            method: 'POST',
+            body: JSON.stringify({
+                isArchived: false,
+                propertyType: 'number',
+                slug: 'subtypeProperty',
+                label: 'Subtype Property',
+                editable: true,
+                searchable: false,
+                core: false,
+                formula: null,
+                referencedTypePath: null,
+                carryOverBehavior: null,
+                carryOverDefault: null,
+                referencedTypeRootSlug: null,
+                defaultValue: null,
+                typePropertyUserListId: null,
+                referencedTypeRole: null,
+                isUniqueProperty: false,
+                isUniquePropertyInFamily: false,
+                propertyLevel: null,
+                formulaFunction: null,
+                validationFunction: null,
+                numberFormat: null,
+                sequenceSeedValue: null,
+            }),
+        }));
+    });
+});
+const FULL_TYPE_YML = `
+- typePath: color
+  slug: color
+  label: Color
+  isArchived: false
+  typeProperties:
+    - slug: blue
+      isArchived: false
+      propertyType: number
+      label: Blue
+      editable: true
+      searchable: false
+      core: false
+      formula: null
+      referencedTypePath: null
+      referencedTypeRootSlug: null
+      typePropertyUserListId: null
+      typePropertyUserListName: ''
+      referencedTypeRole: null
+      defaultValue: null
+      propertyLevel: null
+      carryOverBehavior: null
+      carryOverDefault: null
+      isUniqueProperty: false
+      isUniquePropertyInFamily: false
+      inherited: false
+      formulaFunction: null
+      validationFunction: null
+      numberFormat: null
+      sequenceSeedValue: null
+    - slug: createdOn
+      isArchived: false
+      propertyType: date
+      label: Created On
+      editable: false
+      searchable: false
+      core: true
+      formula: null
+      referencedTypePath: null
+      referencedTypeRootSlug: null
+      typePropertyUserListId: null
+      typePropertyUserListName: ''
+      referencedTypeRole: null
+      defaultValue: null
+      propertyLevel: null
+      carryOverBehavior: null
+      carryOverDefault: null
+      isUniqueProperty: false
+      isUniquePropertyInFamily: false
+      inherited: false
+      formulaFunction: null
+      validationFunction: null
+      numberFormat: null
+      sequenceSeedValue: null
+    - slug: federatedId
+      isArchived: false
+      propertyType: sequence
+      label: Federated Id
+      editable: true
+      searchable: false
+      core: false
+      formula: null
+      referencedTypePath: null
+      referencedTypeRootSlug: null
+      typePropertyUserListId: null
+      typePropertyUserListName: ''
+      referencedTypeRole: null
+      defaultValue: null
+      propertyLevel: null
+      carryOverBehavior: null
+      carryOverDefault: null
+      isUniqueProperty: false
+      isUniquePropertyInFamily: false
+      inherited: false
+      formulaFunction: null
+      validationFunction: null
+      numberFormat: null
+      sequenceSeedValue: 1
+    - slug: green
+      isArchived: false
+      propertyType: number
+      label: Green
+      editable: true
+      searchable: false
+      core: false
+      formula: null
+      referencedTypePath: null
+      referencedTypeRootSlug: null
+      typePropertyUserListId: null
+      typePropertyUserListName: ''
+      referencedTypeRole: null
+      defaultValue: null
+      propertyLevel: null
+      carryOverBehavior: null
+      carryOverDefault: null
+      isUniqueProperty: false
+      isUniquePropertyInFamily: false
+      inherited: false
+      formulaFunction: null
+      validationFunction: null
+      numberFormat: null
+      sequenceSeedValue: null
+    - slug: hex
+      isArchived: false
+      propertyType: string
+      label: Hex
+      editable: true
+      searchable: false
+      core: false
+      formula: null
+      referencedTypePath: null
+      referencedTypeRootSlug: null
+      typePropertyUserListId: null
+      typePropertyUserListName: ''
+      referencedTypeRole: null
+      defaultValue: null
+      propertyLevel: null
+      carryOverBehavior: null
+      carryOverDefault: null
+      isUniqueProperty: false
+      isUniquePropertyInFamily: false
+      inherited: false
+      formulaFunction: null
+      validationFunction: null
+      numberFormat: null
+      sequenceSeedValue: null
+    - slug: hexCode
+      isArchived: false
+      propertyType: string
+      label: Hex Code
+      editable: true
+      searchable: false
+      core: false
+      formula: null
+      referencedTypePath: null
+      referencedTypeRootSlug: null
+      typePropertyUserListId: null
+      typePropertyUserListName: ''
+      referencedTypeRole: null
+      defaultValue: null
+      propertyLevel: null
+      carryOverBehavior: null
+      carryOverDefault: null
+      isUniqueProperty: false
+      isUniquePropertyInFamily: false
+      inherited: false
+      formulaFunction: null
+      validationFunction: null
+      numberFormat: null
+      sequenceSeedValue: null
+    - slug: isArchived
+      isArchived: false
+      propertyType: boolean
+      label: Archived
+      editable: true
+      searchable: false
+      core: false
+      formula: null
+      referencedTypePath: null
+      referencedTypeRootSlug: null
+      typePropertyUserListId: null
+      typePropertyUserListName: ''
+      referencedTypeRole: null
+      defaultValue: null
+      propertyLevel: null
+      carryOverBehavior: null
+      carryOverDefault: null
+      isUniqueProperty: false
+      isUniquePropertyInFamily: false
+      inherited: false
+      formulaFunction: null
+      validationFunction: null
+      numberFormat: null
+      sequenceSeedValue: null
+    - slug: name
+      isArchived: false
+      propertyType: string
+      label: Name
+      editable: true
+      searchable: false
+      core: false
+      formula: null
+      referencedTypePath: null
+      referencedTypeRootSlug: null
+      typePropertyUserListId: null
+      typePropertyUserListName: ''
+      referencedTypeRole: null
+      defaultValue: null
+      propertyLevel: null
+      carryOverBehavior: null
+      carryOverDefault: null
+      isUniqueProperty: false
+      isUniquePropertyInFamily: false
+      inherited: false
+      formulaFunction: null
+      validationFunction: null
+      numberFormat: null
+      sequenceSeedValue: null
+    - slug: red
+      isArchived: false
+      propertyType: number
+      label: Red
+      editable: true
+      searchable: false
+      core: false
+      formula: null
+      referencedTypePath: null
+      referencedTypeRootSlug: null
+      typePropertyUserListId: null
+      typePropertyUserListName: ''
+      referencedTypeRole: null
+      defaultValue: null
+      propertyLevel: null
+      carryOverBehavior: null
+      carryOverDefault: null
+      isUniqueProperty: false
+      isUniquePropertyInFamily: false
+      inherited: false
+      formulaFunction: null
+      validationFunction: null
+      numberFormat: null
+      sequenceSeedValue: null
+    - slug: rgb
+      isArchived: false
+      propertyType: string
+      label: RGB
+      editable: true
+      searchable: false
+      core: false
+      formula: null
+      referencedTypePath: null
+      referencedTypeRootSlug: null
+      typePropertyUserListId: null
+      typePropertyUserListName: ''
+      referencedTypeRole: null
+      defaultValue: null
+      propertyLevel: null
+      carryOverBehavior: null
+      carryOverDefault: null
+      isUniqueProperty: false
+      isUniquePropertyInFamily: false
+      inherited: false
+      formulaFunction: null
+      validationFunction: null
+      numberFormat: null
+      sequenceSeedValue: null
+    - slug: rgba
+      isArchived: false
+      propertyType: string
+      label: RGBA
+      editable: true
+      searchable: false
+      core: false
+      formula: null
+      referencedTypePath: null
+      referencedTypeRootSlug: null
+      typePropertyUserListId: null
+      typePropertyUserListName: ''
+      referencedTypeRole: null
+      defaultValue: null
+      propertyLevel: null
+      carryOverBehavior: null
+      carryOverDefault: null
+      isUniqueProperty: false
+      isUniquePropertyInFamily: false
+      inherited: false
+      formulaFunction: null
+      validationFunction: null
+      numberFormat: null
+      sequenceSeedValue: null
+    - slug: updatedOn
+      isArchived: false
+      propertyType: date
+      label: Updated On
+      editable: false
+      searchable: false
+      core: true
+      formula: null
+      referencedTypePath: null
+      referencedTypeRootSlug: null
+      typePropertyUserListId: null
+      typePropertyUserListName: ''
+      referencedTypeRole: null
+      defaultValue: null
+      propertyLevel: null
+      carryOverBehavior: null
+      carryOverDefault: null
+      isUniqueProperty: false
+      isUniquePropertyInFamily: false
+      inherited: false
+      formulaFunction: null
+      validationFunction: null
+      numberFormat: null
+      sequenceSeedValue: null
+`;
+const SUBTYPE_WITH_PROPERTY_YML = `
+- typePath: color:test-subtype
+  slug: test-subtype
+  label: Color Test Subtype
+  isArchived: false
+  typeProperties:
+    - slug: subtypeProperty
+      isArchived: false
+      propertyType: number
+      label: Subtype Property
+      editable: true
+      searchable: false
+      core: false
+      formula: null
+      referencedTypePath: null
+      referencedTypeRootSlug: null
+      typePropertyUserListId: null
+      typePropertyUserListName: ''
+      referencedTypeRole: null
+      defaultValue: null
+      propertyLevel: null
+      carryOverBehavior: null
+      carryOverDefault: null
+      isUniqueProperty: false
+      isUniquePropertyInFamily: false
+      inherited: false
+      formulaFunction: null
+      validationFunction: null
+      numberFormat: null
+      sequenceSeedValue: null
+`;
+const TYPE_WITH_UPDATED_LABEL_YML = `
+- typePath: color
+  label: Color 2
+`;
+const TYPE_WITH_NEW_PROPERTY_YML = `
+- typePath: color
+  typeProperties:
+    - slug: code
+      isArchived: false
+      propertyType: number
+      label: Code
+      editable: true
+      searchable: false
+      core: false
+      formula: null
+      referencedTypePath: null
+      referencedTypeRootSlug: null
+      typePropertyUserListId: null
+      typePropertyUserListName: ''
+      referencedTypeRole: null
+      defaultValue: null
+      propertyLevel: null
+      carryOverBehavior: null
+      carryOverDefault: null
+      isUniqueProperty: false
+      isUniquePropertyInFamily: false
+      inherited: false
+      formulaFunction: null
+      validationFunction: null
+      numberFormat: null
+      sequenceSeedValue: null
+`;
+const TYPE_WITH_UPDATED_PROPERTY_YML = `
+- typePath: color
+  typeProperties:
+    - slug: rgb
+      isArchived: true
+`;

package/dist/interfaces.d.ts

@@ -360,6 +360,7 @@ export interface ReducedTypeProperty {
     validationFunction?: string;
     numberFormat?: any;
     sequenceSeedValue?: number;
+    copyBehavior?: string;
 }
 export interface ReducedOptionSet {
     name: string;

package/dist/templates/typescript/README.md

@@ -1,5 +1,7 @@
 ### Running your app
+
 Run `npm run start` at the root directory of your app (where the `package.json` file is located).
 
 ### Publishing your app
-Run `contrail app publish` to publish a new version of the app.
+
+Run `contrail app publish` to publish a new version of the app.

package/dist/templates/typescript/app.yml

@@ -1,7 +1,7 @@
 appIdentifier: 'APP_IDENTIFIER_STUB' # Change to be your company root domain and the name of the app
 appName: 'APP_NAME_STUB' # Give your app a name
 appDescription: 'APP_DESCRIPTION_STUB' # Give your app a description
-nodeRuntime: 'NODE_RUNTIME_STUB' # The Node.js runtime version to use for your app
+nodeRuntime: 'nodejs22.x' # The Node.js runtime version to use for your app
 visibility: private # This should be private unless you want to develop an app for all VibeIQ customers to use
 # Access Grants
 # Use this section to share this app with other organizations.

package/dist/templates/typescript/assets/sample.json

@@ -1,3 +1,3 @@
 {
   "foo": "bar"
-}
+}

package/dist/templates/typescript/eslintrc.json

@@ -25,10 +25,7 @@
     "no-multiple-empty-lines": ["error", { "max": 1, "maxEOF": 0 }],
     "no-trailing-spaces": "error",
     "no-mixed-spaces-and-tabs": ["error", "smart-tabs"],
-    "@typescript-eslint/no-empty-function": [
-      "error",
-      { "allow": ["arrowFunctions"] }
-    ],
+    "@typescript-eslint/no-empty-function": ["error", { "allow": ["arrowFunctions"] }],
     "@typescript-eslint/no-explicit-any": "off",
     "@typescript-eslint/no-var-requires": "warn",
     "no-unused-vars": "off",

package/dist/templates/typescript/tsconfig.json

@@ -4,15 +4,7 @@
     "emitDecoratorMetadata": true,
     "esModuleInterop": true,
     "experimentalDecorators": true,
-    "lib": [
-      "es5",
-      "ES2015",
-      "ES2016",
-      "ES2017",
-      "ES2020",
-      "dom",
-      "esnext.asynciterable"
-    ],
+    "lib": ["es5", "ES2015", "ES2016", "ES2017", "ES2020", "dom", "esnext.asynciterable"],
     "module": "CommonJS",
     // "moduleResolution": "node",
     "noImplicitAny": false,
@@ -22,16 +14,8 @@
     "strict": false,
     "strictPropertyInitialization": false,
     "target": "ES2020",
-    "types": [
-      "node", "jest"
-    ]
+    "types": ["node", "jest"]
   },
-  "exclude": [
-    "node_modules",
-    "**/__tests__/*"
-  ],
-  "include": [
-    "src",
-    "package.json"
-  ]
-}
+  "exclude": ["node_modules", "**/__tests__/*"],
+  "include": ["src", "package.json"]
+}