@managespace/sdk 0.0.1

package/README.md

@@ -0,0 +1,6 @@
+# @managespace/extensibility
+
+update version number in package.json
+npm i
+npm run build
+npm publish

package/package.json

@@ -0,0 +1,21 @@
+{
+    "name": "@managespace/sdk",
+    "version": "0.0.1",
+    "scripts": {
+        "lint:check": "eslint .",
+        "lint:fix": "eslint --fix ."
+    },
+    "exports": {
+        ".": "./src/index.ts"
+    },
+    "dependencies": {
+        "tslib": "^2.4.0",
+        "zod": "^3.23.8"
+    },
+    "devDependencies": {
+        "@types/node": "^12",
+        "typescript": "^4.0",
+        "@repo/eslint-config": "*",
+        "@repo/typescript-config": "*"
+    }
+}

package/src/extensibility/functions/extensibility-function.ts

@@ -0,0 +1,20 @@
+import { DefaultApi } from '../../generated';
+import { ExtReturnType } from '../types';
+import { ExtPlugin, ExtBasePayload } from '../types';
+
+export const defineExFn = <T extends ExtPlugin>(
+    callback: (
+        payload: ExtBasePayload & T['payload'],
+        api: DefaultApi,
+    ) => Promise<ExtReturnType<T['responseType']>>,
+) => {
+    // let fnDescription = 'some default description';
+
+    return {
+        message: 'anything here that could help with AST',
+        // setDescription: (description: string) => {
+        //     fnDescription = description;
+        // },
+        callback,
+    };
+};

package/src/extensibility/functions/index.ts

@@ -0,0 +1,2 @@
+export * from './extensibility-function';
+export * from './project';

package/src/extensibility/functions/project/all-topics.ts

@@ -0,0 +1,34 @@
+// import * as Projects from "./index";
+// import importSync from "import-sync";
+// import { Billing } from './billing';
+// import { Document } from './document';
+import { ManageSpace } from './managespace';
+
+// const foundTopics: string[] = [...Object.keys(Billing).map((topic) => `Billing.${topic}`)];
+
+// Object.keys(Projects).forEach((project) => {
+//     const importedProject = importSync(`./${project}`);
+//     Object.keys(importedProject).forEach((topic) => {
+//         topics.push(`${project}.${topic}`);
+//     });
+// });
+
+// TODO: Ensure all these events exist in the new project/naming structure
+// account_created
+// catalog_updated
+// invoice_created
+// subscription_created
+// move_in_requested
+// move_out_requested
+// create_calendar_event
+// document_required
+// catalog_created
+// create_customer
+// create_contact
+// send_sms
+
+export const allTopics = [
+    // ...Object.keys(Billing).map((topic) => `Billing.${topic}`),
+    // ...Object.keys(Document).map((topic) => `Document.${topic}`),
+    ...Object.keys(ManageSpace).map((topic) => `ManageSpace.${topic}`),
+];

package/src/extensibility/functions/project/billing.ts

@@ -0,0 +1,249 @@
+/* eslint-disable @typescript-eslint/no-namespace */
+import {
+    BillingRunResponse,
+    ChargeResponse,
+    InvoiceResponse,
+    CreateBillingRun as CreateBillingRunPayload,
+    CreatePaymentRun as CreatePaymentRunPayload,
+    CustomChartOfAccounts,
+    CustomerResponse,
+    SubscriptionResponse,
+    ProductBillingResponse,
+    PlanResponse,
+    PaymentRunResponse,
+    CustomerId,
+    GetContactResponse,
+    GetCustomerResponse,
+    CreateProductBilling,
+    CreatePlanBilling,
+    CustomUpdateCustomer,
+    ChartOfAccountResponse,
+    ChartOfAccountsResponse,
+    RevenueRuleResponse,
+    CreateSubscriptionBilling,
+    CreatePaymentBilling,
+    PaymentResponse,
+    StatementResponse,
+    CancelSubscriptionBilling,
+} from '../../../generated';
+import { ExtPlugin } from '../../types';
+// TODO: import this from common, import it all from common ideally
+type BasePaginationQuery = { offset: number; limit: number };
+
+export namespace Billing {
+    export class CreateBillingRun implements ExtPlugin {
+        responseType!: BillingRunResponse;
+        payload!: { createBillingRunPayload: CreateBillingRunPayload };
+    }
+
+    export class CreatePaymentRun implements ExtPlugin {
+        responseType!: PaymentRunResponse;
+        payload!: { createPaymentRunPayload: CreatePaymentRunPayload };
+    }
+
+    export class CreateChartOfAccounts implements ExtPlugin {
+        responseType!: ChartOfAccountsResponse;
+        payload!: { chartOfAccountPayload: CustomChartOfAccounts };
+    }
+
+    //TODO: Use SiteId instead of string?
+    export class CreateContact implements ExtPlugin {
+        responseType!: GetContactResponse;
+        payload!: {
+            siteId: string;
+            contactId: string;
+        };
+    }
+
+    export class ContactCreated implements ExtPlugin {
+        responseType!: any;
+        payload!: any;
+    }
+
+    export class CreateCustomer implements ExtPlugin {
+        responseType!: GetCustomerResponse;
+        payload!: {
+            siteId: string;
+            customerId: string;
+        };
+    }
+
+    export class CustomerCreated implements ExtPlugin {
+        responseType!: any;
+        payload!: any;
+    }
+
+    export class GetBillingRuns implements ExtPlugin {
+        responseType!: BillingRunResponse[];
+        payload!: BasePaginationQuery;
+    }
+
+    export class GetBillingRun implements ExtPlugin {
+        responseType!: BillingRunResponse;
+        payload!: { billingRunId: string };
+    }
+
+    export class GetCharges implements ExtPlugin {
+        responseType!: ChargeResponse[];
+        payload!: { planId: string } & BasePaginationQuery;
+    }
+
+    export class GetCharge implements ExtPlugin {
+        responseType!: ChargeResponse;
+        payload!: { planId: string; chargeId: string };
+    }
+
+    export class GetCustomers implements ExtPlugin {
+        responseType!: CustomerResponse[];
+        payload!: BasePaginationQuery;
+    }
+
+    export class GetCustomer implements ExtPlugin {
+        responseType!: CustomerResponse;
+        payload!: { customerId: CustomerId };
+    }
+
+    export class GetInvoices implements ExtPlugin {
+        responseType!: InvoiceResponse[];
+        payload!: BasePaginationQuery;
+    }
+
+    export class GetInvoice implements ExtPlugin {
+        responseType!: InvoiceResponse;
+        payload!: {
+            invoiceId: string;
+        };
+    }
+
+    export class GetPaymentRuns implements ExtPlugin {
+        responseType!: PaymentRunResponse[];
+        payload!: BasePaginationQuery;
+    }
+
+    export class GetPaymentRun implements ExtPlugin {
+        responseType!: PaymentRunResponse;
+        payload!: { paymentRunId: string };
+    }
+
+    export class GetPayments implements ExtPlugin {
+        responseType!: PaymentResponse[];
+        payload!: BasePaginationQuery;
+    }
+
+    export class GetPayment implements ExtPlugin {
+        responseType!: PaymentResponse;
+        payload!: { paymentId: string };
+    }
+
+    export class GetPlans implements ExtPlugin {
+        responseType!: PlanResponse[];
+        payload!: BasePaginationQuery & { name?: string; active?: boolean };
+    }
+
+    export class GetPlan implements ExtPlugin {
+        responseType!: PlanResponse;
+        payload!: { planId: string };
+    }
+
+    export class GetProducts implements ExtPlugin {
+        responseType!: ProductBillingResponse[];
+        payload!: BasePaginationQuery;
+    }
+
+    export class GetProduct implements ExtPlugin {
+        responseType!: ProductBillingResponse;
+        payload!: { productId: string };
+    }
+
+    export class GetSubscriptions implements ExtPlugin {
+        responseType!: SubscriptionResponse[];
+        payload!: BasePaginationQuery & { assetId?: string };
+    }
+
+    export class GetSubscription implements ExtPlugin {
+        responseType!: SubscriptionResponse;
+        payload!: { subscriptionId: string };
+    }
+
+    export class CreateProduct implements ExtPlugin {
+        responseType!: ProductBillingResponse;
+        payload!: { createProductPayload: CreateProductBilling };
+    }
+
+    export class CreatePlan implements ExtPlugin {
+        responseType!: PlanResponse;
+        payload!: {
+            createPlanPayload: CreatePlanBilling;
+        };
+    }
+
+    export class UpdateCustomer implements ExtPlugin {
+        responseType!: GetCustomerResponse;
+        payload!: {
+            siteId: string;
+            customerId: string;
+            updateCustomerPayload: CustomUpdateCustomer;
+        };
+    }
+
+    export class GetChartOfAccount implements ExtPlugin {
+        responseType!: ChartOfAccountResponse;
+        payload!: {
+            siteId: string;
+            chartOfAccountId: string;
+        };
+    }
+
+    export class GetChartOfAccounts implements ExtPlugin {
+        responseType!: ChartOfAccountResponse[];
+        payload!: BasePaginationQuery;
+    }
+
+    export class GetRevenueRule implements ExtPlugin {
+        responseType!: RevenueRuleResponse;
+        payload!: { revenueRuleId: string };
+    }
+
+    export class GetRevenueRules implements ExtPlugin {
+        responseType!: RevenueRuleResponse[];
+        payload!: BasePaginationQuery;
+    }
+
+    export class CreateSubscription implements ExtPlugin {
+        responseType!: SubscriptionResponse;
+        payload!: { createSubscriptionPayload: CreateSubscriptionBilling };
+    }
+
+    export class CreatePayment implements ExtPlugin {
+        responseType!: PaymentResponse;
+        payload!: { createPaymentPayload: CreatePaymentBilling };
+    }
+
+    export class GetStatements implements ExtPlugin {
+        responseType!: StatementResponse[];
+        payload!: BasePaginationQuery;
+    }
+
+    export class GetStatement implements ExtPlugin {
+        responseType!: StatementResponse;
+        payload!: { statementId: string };
+    }
+
+    export class PaymentCreated implements ExtPlugin {
+        responseType!: any;
+        payload!: any;
+    }
+
+    export class InvoiceCreated implements ExtPlugin {
+        responseType!: any;
+        payload!: any;
+    }
+
+    export class CancelSubscription implements ExtPlugin {
+        responseType!: SubscriptionResponse;
+        payload!: {
+            subscriptionId: string;
+            cancelSubscriptionPayload: CancelSubscriptionBilling;
+        };
+    }
+}

package/src/extensibility/functions/project/document.ts

@@ -0,0 +1,39 @@
+/* eslint-disable @typescript-eslint/no-namespace */
+import {
+    DocumentUrlsResponse,
+    CreateTemplate as CreateTemplatePayload,
+} from '../../../generated';
+import { ExtPlugin } from '../../types';
+
+export namespace Document {
+    export class Create implements ExtPlugin {
+        responseType!: DocumentUrlsResponse;
+        payload!: {
+            context: string;
+            contactId?: string;
+            customerId?: string;
+            userId?: string;
+            assetId?: string;
+            workflowId?: string;
+            workflowStepId?: string;
+        };
+    }
+    export class CreateTemplate implements ExtPlugin {
+        responseType!: any;
+        payload!: CreateTemplatePayload;
+    }
+    export class Signed implements ExtPlugin {
+        responseType!: any;
+        payload!: {
+            orgId: string;
+            siteId: string;
+            documentId: string;
+            contactId: string;
+            customerId: string;
+            assetId: string;
+            workflowId: string;
+            workflowStepId: string;
+            allSignaturesGathered: boolean;
+        };
+    }
+}

package/src/extensibility/functions/project/index.ts

@@ -0,0 +1,5 @@
+export * from './billing';
+export * from './document';
+export * from './managespace';
+export * from './all-topics';
+export * from './topics.type';

package/src/extensibility/functions/project/managespace.ts

@@ -0,0 +1,95 @@
+/* eslint-disable @typescript-eslint/no-namespace */
+import {
+    CustomerResponse,
+    CustomAddCustomerContact,
+    WorkflowStepInstanceResponse,
+    WorkflowInstanceResponse,
+} from '../../../generated';
+import { ExtPlugin } from '../../types';
+
+export namespace ManageSpace {
+    export class SmartBarRequest<
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        TIntent extends string,
+        TEntities extends string[],
+    > implements ExtPlugin
+    {
+        responseType!: string[];
+        payload!: Record<TEntities[number], string | null> & {
+            userEmail: string;
+        };
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    export class HandleEvent<JsonAta extends string> implements ExtPlugin {
+        responseType!: any;
+        payload!: any;
+    }
+
+    export class SubscriptionCreated implements ExtPlugin {
+        responseType!: any;
+        payload!: {
+            subscriptionId: string;
+        };
+    }
+
+    export class CreateMoveIn implements ExtPlugin {
+        responseType!: any;
+        payload!: any;
+    }
+
+    export class CreateMoveOut implements ExtPlugin {
+        responseType!: any;
+        payload!: any;
+    }
+
+    export class TestManualInput implements ExtPlugin {
+        responseType!: any;
+        payload!: any;
+    }
+
+    export class CustomerCreated implements ExtPlugin {
+        responseType!: any;
+        payload!: { customerId: string };
+    }
+
+    export class CustomerUpdated implements ExtPlugin {
+        responseType!: any;
+        payload!: CustomerResponse & { customerId: string };
+    }
+
+    export class CustomerContactCreated implements ExtPlugin {
+        responseType!: any;
+        payload!: CustomAddCustomerContact & { customerId: string };
+    }
+
+    export class ContactCreated implements ExtPlugin {
+        responseType!: any;
+        payload!: { contactId: string };
+    }
+
+    export class WorkflowStepReady implements ExtPlugin {
+        responseType!: any;
+        payload!: WorkflowStepInstanceResponse;
+    }
+
+    export class WorkflowInstanceCreated implements ExtPlugin {
+        responseType!: any;
+        payload!: WorkflowInstanceResponse;
+    }
+
+    export class RepositoryUpdated implements ExtPlugin {
+        responseType!: any;
+        payload!: { branch: string; commit: string };
+    }
+
+    export class JasonTestEvent implements ExtPlugin {
+        responseType!: any;
+        payload!: any;
+    }
+
+    export class JacksonTestEvent implements ExtPlugin {
+        responseType!: any;
+        payload!: any;
+    }
+}

package/src/extensibility/functions/project/topics.type.ts

@@ -0,0 +1,16 @@
+export type Topics =
+    | 'ManageSpace.SmartBarRequest'
+    | 'ManageSpace.HandleEvent'
+    | 'ManageSpace.SubscriptionCreated'
+    | 'ManageSpace.CreateMoveIn'
+    | 'ManageSpace.CreateMoveOut'
+    | 'ManageSpace.TestManualInput'
+    | 'ManageSpace.CustomerCreated'
+    | 'ManageSpace.CustomerUpdated'
+    | 'ManageSpace.CustomerContactCreated'
+    | 'ManageSpace.ContactCreated'
+    | 'ManageSpace.WorkflowStepReady'
+    | 'ManageSpace.WorkflowInstanceCreated'
+    | 'ManageSpace.RepositoryUpdated'
+    | 'ManageSpace.JasonTestEvent'
+    | 'ManageSpace.JacksonTestEvent';

package/src/extensibility/index.ts

@@ -0,0 +1,4 @@
+export * from './functions';
+export * from './types';
+export * from './utils';
+export * from './workflow';

package/src/extensibility/types/control.ts

@@ -0,0 +1,48 @@
+// import { ApiFunctions } from '.';
+
+export type ControlValidation = {
+    type: string;
+    pattern: string;
+    errorMessage: string;
+};
+
+export type PageControl = {
+    label: string;
+    type:
+        | 'number'
+        | 'text'
+        | 'date'
+        | 'checkbox'
+        | 'textarea'
+        | 'asset'
+        | 'customer'
+        | 'contact'
+        | 'user';
+    responseField: string;
+    required: boolean;
+    placeholder?: string;
+    validation?: ControlValidation;
+};
+
+export type SectionLayout = {
+    columns?: number;
+};
+
+export type PageSection = {
+    heading: string;
+    description?: string;
+    layout?: SectionLayout;
+    controls: PageControl[];
+};
+
+export type PageGroup = {
+    groupTitle: string;
+    groupDescription?: string;
+    sections: PageSection[];
+};
+
+export type UserIntervention = {
+    formTitle: string;
+    description: string;
+    pageGroups: PageGroup[];
+};

package/src/extensibility/types/default-result.ts

@@ -0,0 +1,25 @@
+// TODO: Look at removing WaitForManualInput, Delay, ManualInputReceived so the user cannot use them - they are only for system use
+export type DefaultPorts =
+    | 'Success'
+    | 'Exception'
+    | 'Warning'
+    | 'End'
+    | 'Delay'
+    | 'WaitForManualInput'
+    | 'ManualInputReceived';
+
+export type ExtensibilityPorts = 'Success' | 'Error';
+
+export const DefaultResult = [
+    'Success',
+    'Exception',
+    'Warning',
+    'End',
+    'Delay',
+    'WaitForManualInput',
+    'ManualInputReceived',
+];
+
+// export type DefaultPorts = (typeof DefaultResult)[number];
+
+export type A = DefaultPorts | 'Error';

package/src/extensibility/types/extensibility.ts

@@ -0,0 +1,12 @@
+export type ExtPlugin = {
+    responseType: any;
+    payload: any;
+};
+export type ExtBasePayload = {
+    orgId: string;
+    siteId?: string;
+    instanceId: string;
+};
+export type ExtReturnType<T, A = null> =
+    | ({ result: T; error?: never } & (A extends null ? unknown : A))
+    | { error: Error; result?: never };

package/src/extensibility/types/index.ts

@@ -0,0 +1,5 @@
+export * from './default-result';
+export * from './mapped-ports';
+export * from './step-function-signature';
+export * from './control';
+export * from './extensibility';

package/src/extensibility/types/mapped-ports.ts

@@ -0,0 +1,13 @@
+import { DefaultPorts } from './default-result';
+import { StepFunctionSignature } from './step-function-signature';
+
+export type MappedPorts<T extends string> = {
+    [K in T]?:
+        | StepFunctionSignature
+        | DefaultPorts
+        | undefined
+        | {
+              callback: StepFunctionSignature;
+              setDescription: (description: string) => void;
+          };
+};

package/src/extensibility/types/step-function-signature.ts

@@ -0,0 +1,11 @@
+import { DefaultApi } from '../../generated';
+import {
+    WorkflowStepBasePayload,
+    WorkflowStepReturnType,
+} from './workflow-step';
+
+export type StepFunctionSignature = (
+    payload: WorkflowStepBasePayload & any,
+    api: DefaultApi,
+    state: any,
+) => Promise<WorkflowStepReturnType<string>>;

package/src/extensibility/types/workflow-step.ts

@@ -0,0 +1,63 @@
+import { UserIntervention } from './control';
+
+export type WorkflowStepBasePayload = {
+    orgId: string;
+    siteId: string;
+    instanceId: string;
+};
+
+export type WorkflowStepDelay =
+    | {
+          weeks: number;
+          days?: number;
+          hours?: number;
+          minutes?: number;
+      }
+    | {
+          weeks?: number;
+          days: number;
+          hours?: number;
+          minutes?: number;
+      }
+    | {
+          weeks?: number;
+          days?: number;
+          hours: number;
+          minutes?: number;
+      }
+    | {
+          weeks?: number;
+          days?: number;
+          hours?: number;
+          minutes: number;
+      };
+
+export type WorkflowStepReturnType<T, A = null> =
+    | ({
+          result: T;
+          state: any;
+          error?: never;
+          userIntervention?: never;
+          delay?: never;
+      } & (A extends null ? unknown : A))
+    | {
+          error: Error;
+          result?: never;
+          state?: never;
+          userIntervention?: never;
+          delay?: never;
+      }
+    | {
+          userIntervention: UserIntervention;
+          result?: never;
+          state?: never;
+          error?: never;
+          delay?: never;
+      }
+    | {
+          delay: WorkflowStepDelay;
+          userIntervention?: never;
+          result?: never;
+          state?: never;
+          error?: never;
+      };

package/src/extensibility/utils/index.ts

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