@or-sdk/card-templates 1.0.1-beta.493.0

package/src/constants.ts

@@ -0,0 +1,109 @@
+export const DEFAULT_PROJECTION_LIST = [
+  'id',
+  'template',
+  'template.category',
+  'template.description',
+  'template.help',
+  'template.icon',
+  'template.iconUrl',
+  'template.implicitly',
+  'template.label',
+  'template.publishedBy',
+  'template.tags',
+  'template.type',
+  'template.version',
+];
+
+export const DEFAULT_PROJECTION_GET_LIST = [
+  'id',
+  'schemaVersion',
+  'dateCreated',
+  'dateModified',
+  'data',
+  'data.data',
+  'data.form',
+  'data.form.code',
+  'data.form.data',
+  'data.form.style',
+  'data.form.template',
+  'data.presentation',
+  'data.presentation.code',
+  'data.presentation.data',
+  'data.presentation.style',
+  'data.presentation.template',
+  'data.tagIds',
+  'reference',
+  'reference.id',
+  'reference.type',
+  'template',
+  'template.category',
+  'template.description',
+  'template.help',
+  'template.icon',
+  'template.iconUrl',
+  'template.implicitly',
+  'template.label',
+  'template.publishedBy',
+  'template.tags',
+  'template.type',
+  'template.version',
+  'deletedDate @include(if: false)',
+];
+
+export const QUERY_DOWNLOAD_TO = `mutation downloadTo($entity: TemplateType!, $data: DownloadInput!) {
+  downloadTo(entity: $entity, data: $data) {
+    ... on Card {
+      id
+      schemaVersion
+      dateCreated
+      dateModified
+      data {
+        data
+        form {
+          code
+          data
+          style
+          template
+        }
+        presentation {
+          code
+          data
+          style
+          template
+        }
+        tagIds
+      }
+      reference {
+        id
+        type
+      }
+      template {
+        category
+        description
+        help
+        icon
+        iconUrl
+        implicitly
+        label
+        publishedBy
+        tags
+        type
+        version
+      }
+      deletedDate @include(if: false)
+    }
+  }
+}
+`;
+
+
+export const QUERY_UPGRADE = `mutation upgrade($entity: TemplateType!, $id: String!, $options: UpgradeOptions) {
+  upgrade(entity: $entity, id: $id, options: $options) {
+      ... on Card {
+          id
+      }
+  }
+}
+`;
+
+export const ENTITY_NAME = 'CARD';

package/src/index.ts

@@ -0,0 +1,2 @@
+export { CardTemplates } from './CardTemplates';
+export * from './types';

package/src/types.ts

@@ -0,0 +1,89 @@
+import { Token } from '@or-sdk/base';
+
+export type CardTemplatesConfig = {
+  /**
+   * token
+   */
+  token: Token;
+
+  /**
+   * Url of OneReach service discovery api
+   */
+  discoveryUrl?: string;
+
+  /**
+   * Account ID for cross-account requests (super admin only)
+   */
+  accountId?: string;
+
+  /**
+   * Url of OneReach DataHub api
+   */
+  dataHubUrl?: string;
+};
+
+export type CardTemplate = {
+  id: string;
+  template: {
+    category: string;
+    description: string;
+    help: string | null;
+    icon: string;
+    iconUrl: string | null;
+    implicitly: unknown;
+    label: string;
+    publishedBy: string;
+    tags: string[] | null;
+    type: string | null;
+    version: string;
+  };
+};
+
+export type Card = {
+  id?: string;
+  schemaVersion?: number;
+  dateCreated?: number;
+  dateModified?: number;
+  data: {
+    presentation: {
+      template: string;
+      code: string;
+      style: string;
+      data: {
+        [key: string]: unknown;
+      } | null;
+    };
+    form: {
+      template: string;
+      code: string;
+      style: string;
+      data: {
+        [key: string]: unknown;
+      };
+    };
+    data: {
+      description: string;
+      height: string;
+      heightOption: string;
+      label: string;
+      viewClasses: string[];
+      width: string;
+      widthOption: string;
+    };
+    tagIds?: string[] | null;
+  };
+  reference?: string | null;
+  template?: string | null;
+};
+
+export type ListCardTemplatesParams = {
+  projection?: string[];
+  limit?: number;
+  queryParams?: {
+    sourceId: string;
+  };
+};
+
+export type GetCardTemplateByIdParams = {
+  projection?: string[];
+};

package/src/utils/getGetByIdQuery.ts

@@ -0,0 +1,14 @@
+import { getQueryProjectionPart } from '@or-sdk/data-hub';
+import { DEFAULT_PROJECTION_GET_LIST } from '../constants';
+
+function getGetByIdQuery({ projection = [] }: { projection: string[]; }): string {
+  return `query getTemplate($entity: TemplateType!, $params: GetInput!, $sourceId: String) {
+  getTemplate(entity: $entity, params: $params, sourceId: $sourceId) {
+    ... on Card {${getQueryProjectionPart(projection.length ? projection : DEFAULT_PROJECTION_GET_LIST)}
+    }
+  }
+}
+`;
+}
+
+export default getGetByIdQuery;

package/src/utils/getListQuery.ts

@@ -0,0 +1,16 @@
+import { getQueryProjectionPart } from '@or-sdk/data-hub';
+import { DEFAULT_PROJECTION_LIST } from '../constants';
+
+function getListQuery({ projection = [] }: { projection: string[]; }): string {
+  return `query listTemplates($entity: TemplateType!, $params: ListInput!, $sourceId: String, $forceSandbox: Boolean) {
+  listTemplates(entity: $entity, params: $params, sourceId: $sourceId, forceSandbox: $forceSandbox) {
+    records {
+      ... on Card {${getQueryProjectionPart(projection.length ? projection : DEFAULT_PROJECTION_LIST)}
+      }
+    }
+    last
+  }
+}`;
+}
+
+export default getListQuery;

package/src/utils/getNewCardTemplate.ts

@@ -0,0 +1,64 @@
+import { v4 as uuidv4 } from 'uuid';
+
+function getNewCardTemplate(stepId?: string) {
+  return {
+    id: stepId || uuidv4(), // this won't change in a future versions of a step
+    version: '0.0.1',
+    cacheVersion: uuidv4(), // this will change every time you save a step template
+    label: '',
+    icon: '',
+    iconType: 'default',
+    iconUrl: '',
+    shape: 'circle',
+    description: '',
+    dateCreated: Date.now(),
+    dateModified: Date.now(),
+    publishedBy: '',
+    template: `/* Your custom logic goes here. */
+// This exits the step down the exit leg labeled \`next\`
+return this.exitStep('next' /*, outputData */ );
+//  This second argument is optional output data, which
+//  will be stored in the step's merge field upon exit.`,
+    categories: [],
+    form: {
+      style: '',
+      template: '',
+      code: '',
+    },
+    data: {
+      exits: [],
+    },
+    modules: [],
+    reporting: {
+      step: {
+        label: 'Step',
+        type: 'step',
+        enabled: true,
+        tags: [],
+      },
+    },
+    outputExample: null,
+    formBuilder: {
+      stepExits: [
+        {
+          component: 'exitStatic',
+          data: {
+            id: 'next',
+            label: 'next',
+          },
+        },
+      ],
+      stepInputs: [],
+      hasDataOut: false,
+      hasProcessError: false,
+      outputExample: null,
+      formTemplate: `<!-- Tread lightly here there be form elements from Design tab, you've been warned! -->
+    <%= inputs ? inputs.join('\\n    ') : '' %>
+<!-- Form elements from Design tab will end here -->`,
+    },
+    rawMode: false,
+    hooks: null,
+  };
+}
+
+export default getNewCardTemplate;

package/src/utils/index.ts

@@ -0,0 +1,7 @@
+/**
+ * @internal
+ */
+
+export { default as getListQuery } from './getListQuery';
+export { default as getGetByIdQuery } from './getGetByIdQuery';
+export { default as getNewCardTemplate } from './getNewCardTemplate';

package/tsconfig.dev.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.esm.json",
+  "compilerOptions": {
+    "declarationDir": "./dist/types",
+    "rootDir": "./src",
+    "declaration": true
+  }
+}

package/tsconfig.esm.json

@@ -0,0 +1,12 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist/esm",
+    "declarationDir": "./dist/types",
+    "module": "ES6",
+    "target": "es6",
+    "rootDir": "./src",
+    "declaration": true,
+    "declarationMap": true
+  }
+}

package/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist/cjs/",
+    "rootDir": "./src"
+  }
+}

package/tsconfig.types.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist/types/",
+    "rootDir": "./src",
+    "declaration": true,
+    "declarationMap": true,
+    "emitDeclarationOnly": true
+  }
+}