@superblocksteam/shared 0.9108.0

package/dist-esm/types/api/index.d.ts

@@ -0,0 +1,149 @@
+import { Api as ApiPb, Trigger_Job, Trigger_Workflow } from '@superblocksteam/types';
+import { Metadata, UserType as ProtoUserType } from '@superblocksteam/types';
+import { Param } from '../common/param';
+import { AuthContext, DatasourceDto, DatasourceEnvironments } from '../datasource';
+import { EventEntityType } from '../event';
+import { IntegrationDto } from '../integration';
+import { Plugin } from '../plugin';
+import { EntityProfileSettings } from '../profile';
+import { IResourceMetadata } from '../resource';
+import { Action, ActionId, Actions } from './action';
+import { ExecutionParam } from './execution';
+import { Global } from './global';
+import { ScheduleConfig, ScheduleState } from './schedule';
+export type ApiNotificationConfiguration = {
+    onSuccess?: {
+        enabled?: boolean;
+        customText?: string;
+    };
+    onError?: {
+        enabled?: boolean;
+        includeError?: boolean;
+        customText?: string;
+        customDescription?: string;
+    };
+};
+export interface Api {
+    id: string;
+    environment: DatasourceEnvironments;
+    profile: string;
+    applicationId?: string | null;
+    actions?: ApiDetails;
+    apiPb?: ApiPb;
+    triggerType: ApiTriggerType;
+}
+export type ApiDetails = {
+    name: string;
+    triggerActionId: ActionId;
+    actions: {
+        [key: string]: Action;
+    };
+    executeOnPageLoad?: boolean;
+    notificationConfig?: ApiNotificationConfiguration;
+    bindings?: string[];
+    dynamicBindingPathList?: Param[];
+    version?: string;
+    deactivated?: Date;
+    created?: Date;
+    updated?: Date;
+    supportedMethod?: 'GET' | 'POST';
+    workflowParams?: ExecutionParam[];
+};
+export type ApiDefinition = {
+    api: Api;
+    orgApiKey: string;
+    organizationId: string;
+    datasources: Record<string, DatasourceDto>;
+    plugins: Record<string, Plugin>;
+    global: Global;
+    locationContext?: ApiLocationContext;
+    metadata?: ApiDefinitionMetadata;
+    authContext?: AuthContext;
+};
+export type ApiLocationContext = {
+    applicationId: string;
+    pageId?: string;
+};
+export type ApiDefinitionMetadata = {
+    requester: string;
+    requesterType?: ProtoUserType;
+    organizationName?: string;
+};
+export declare enum ApiTriggerType {
+    UI = 0,
+    WORKFLOW = 1,
+    SCHEDULE = 2
+}
+export declare enum ApiTriggerTypeQuery {
+    UI = "ui",
+    WORKFLOW = "workflow",
+    SCHEDULE = "schedule"
+}
+export declare function apiTriggerTypeQueryToType(trigger: ApiTriggerTypeQuery): ApiTriggerType;
+export declare function apiTriggerToEntity(trigger: ApiTriggerType): EventEntityType;
+export interface IApiV3Dto {
+    id: string;
+    name: string;
+    applicationId?: string | null;
+    pageId?: string | null;
+    organizationId: string;
+    actions?: Actions;
+    apiPb?: ApiPb;
+    triggerType: ApiTriggerType;
+    updated: number | Date;
+    canDelete?: boolean;
+    scheduleState?: ScheduleState;
+    liveSchedule?: ScheduleConfig;
+    folderId?: string | null;
+    isDeployed?: boolean;
+    deployedCommitId?: string;
+    sendEmailOnFailure?: boolean;
+    integrations?: Record<string, IntegrationDto>;
+    creator?: {
+        id: string;
+        name: string;
+    };
+    settings?: ApiSettings;
+    repoConnection?: {
+        created: Date;
+    } | null;
+    restricted?: boolean;
+}
+export interface IHomepageApiV3Dto extends IResourceMetadata {
+    triggerType?: ApiTriggerType;
+    scheduleState?: ScheduleState;
+    creator?: {
+        id: string;
+        name: string;
+        email: string;
+    };
+}
+type protoMethods = 'equals' | 'clone' | 'fromBinary' | 'fromJson' | 'fromJsonString' | 'toBinary' | 'toJson' | 'toJsonString' | 'getType';
+export declare const EXPORTED_METADATA_EXCLUDED_FIELDS: readonly ["description", "folder", "tags", "timestamps", "version"];
+type ExcludedFields = (typeof EXPORTED_METADATA_EXCLUDED_FIELDS)[number];
+type ExportedApiPbMetadata = Omit<Metadata, ExcludedFields | protoMethods>;
+export type ApiPbTrigger = {
+    workflow?: Trigger_Workflow;
+    job?: Trigger_Job;
+};
+export type ExportedApiPbTrigger = {
+    workflow?: Omit<Trigger_Workflow, 'options' | protoMethods>;
+    job?: Omit<Trigger_Job, 'options' | protoMethods>;
+};
+export type ExportedApiPb = Omit<ApiPb, 'metadata' | 'trigger' | protoMethods> & {
+    metadata: ExportedApiPbMetadata;
+    trigger: ExportedApiPbTrigger | undefined;
+};
+export type ExportedApiV3Dto = Omit<IApiV3Dto, 'updated' | 'triggerType' | 'apiPb' | 'organizationId'> & {
+    apiPb?: ExportedApiPb;
+};
+export type ApiSettings = EntityProfileSettings;
+export type ExportedApiSettings = Omit<ApiSettings, 'profiles'>;
+export { ViewMode as OrchestratorViewMode } from '@superblocksteam/types';
+export * from './action';
+export * from './resolvedActionProp';
+export * from './schedule';
+export * from './execution';
+export * from './global';
+export * from './control-flow';
+//# sourceMappingURL=index.d.ts.map

package/dist-esm/types/api/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,IAAI,KAAK,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AACrF,OAAO,EAAE,QAAQ,EAAE,QAAQ,IAAI,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC7E,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AACxC,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAC;AACnF,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAI3D,MAAM,MAAM,4BAA4B,GAAG;IACzC,SAAS,CAAC,EAAE;QACV,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,OAAO,CAAC,EAAE;QACR,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,YAAY,CAAC,EAAE,OAAO,CAAC;QACvB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,iBAAiB,CAAC,EAAE,MAAM,CAAC;KAC5B,CAAC;CACH,CAAC;AAEF,MAAM,WAAW,GAAG;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,sBAAsB,CAAC;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,WAAW,EAAE,cAAc,CAAC;CAC7B;AAED,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,EAAE,QAAQ,CAAC;IAC1B,OAAO,EAAE;QACP,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;KACvB,CAAC;IACF,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,kBAAkB,CAAC,EAAE,4BAA4B,CAAC;IAClD,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,sBAAsB,CAAC,EAAE,KAAK,EAAE,CAAC;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,IAAI,CAAC;IACnB,OAAO,CAAC,EAAE,IAAI,CAAC;IACf,OAAO,CAAC,EAAE,IAAI,CAAC;IACf,eAAe,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IACjC,cAAc,CAAC,EAAE,cAAc,EAAE,CAAC;CACnC,CAAC;AAGF,MAAM,MAAM,aAAa,GAAG;IAC1B,GAAG,EAAE,GAAG,CAAC;IACT,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAC3C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,CAAC,EAAE,kBAAkB,CAAC;IACrC,QAAQ,CAAC,EAAE,qBAAqB,CAAC;IACjC,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B,CAAC;AAGF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF,oBAAY,cAAc;IACxB,EAAE,IAAA;IACF,QAAQ,IAAA;IACR,QAAQ,IAAA;CACT;AAED,oBAAY,mBAAmB;IAC7B,EAAE,OAAO;IACT,QAAQ,aAAa;IACrB,QAAQ,aAAa;CACtB;AAED,wBAAgB,yBAAyB,CAAC,OAAO,EAAE,mBAAmB,GAAG,cAAc,CAStF;AAED,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,cAAc,GAAG,eAAe,CAS3E;AAED,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,WAAW,EAAE,cAAc,CAAC;IAC5B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,YAAY,CAAC,EAAE,cAAc,CAAC;IAC9B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC9C,OAAO,CAAC,EAAE;QACR,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,QAAQ,CAAC,EAAE,WAAW,CAAC;IACvB,cAAc,CAAC,EAAE;QAAE,OAAO,EAAE,IAAI,CAAA;KAAE,GAAG,IAAI,CAAC;IAC1C,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAID,MAAM,WAAW,iBAAkB,SAAQ,iBAAiB;IAC1D,WAAW,CAAC,EAAE,cAAc,CAAC;IAC7B,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,OAAO,CAAC,EAAE;QACR,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAGD,KAAK,YAAY,GAAG,QAAQ,GAAG,OAAO,GAAG,YAAY,GAAG,UAAU,GAAG,gBAAgB,GAAG,UAAU,GAAG,QAAQ,GAAG,cAAc,GAAG,SAAS,CAAC;AAE3I,eAAO,MAAM,iCAAiC,qEAAsE,CAAC;AAErH,KAAK,cAAc,GAAG,CAAC,OAAO,iCAAiC,CAAC,CAAC,MAAM,CAAC,CAAC;AAEzE,KAAK,qBAAqB,GAAG,IAAI,CAAC,QAAQ,EAAE,cAAc,GAAG,YAAY,CAAC,CAAC;AAE3E,MAAM,MAAM,YAAY,GAAG;IACzB,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B,GAAG,CAAC,EAAE,WAAW,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,QAAQ,CAAC,EAAE,IAAI,CAAC,gBAAgB,EAAE,SAAS,GAAG,YAAY,CAAC,CAAC;IAC5D,GAAG,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,SAAS,GAAG,YAAY,CAAC,CAAC;CACnD,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,GAAG,YAAY,CAAC,GAAG;IAC/E,QAAQ,EAAE,qBAAqB,CAAC;IAChC,OAAO,EAAE,oBAAoB,GAAG,SAAS,CAAC;CAC3C,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,SAAS,EAAE,SAAS,GAAG,aAAa,GAAG,OAAO,GAAG,gBAAgB,CAAC,GAAG;IACvG,KAAK,CAAC,EAAE,aAAa,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,qBAAqB,CAAC;AAEhD,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;AAEhE,OAAO,EAAE,QAAQ,IAAI,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC1E,cAAc,UAAU,CAAC;AACzB,cAAc,sBAAsB,CAAC;AACrC,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC"}

package/dist-esm/types/api/index.js

@@ -0,0 +1,42 @@
+import { EventEntityType } from '../event';
+export var ApiTriggerType;
+(function (ApiTriggerType) {
+    ApiTriggerType[ApiTriggerType["UI"] = 0] = "UI";
+    ApiTriggerType[ApiTriggerType["WORKFLOW"] = 1] = "WORKFLOW";
+    ApiTriggerType[ApiTriggerType["SCHEDULE"] = 2] = "SCHEDULE";
+})(ApiTriggerType || (ApiTriggerType = {}));
+export var ApiTriggerTypeQuery;
+(function (ApiTriggerTypeQuery) {
+    ApiTriggerTypeQuery["UI"] = "ui";
+    ApiTriggerTypeQuery["WORKFLOW"] = "workflow";
+    ApiTriggerTypeQuery["SCHEDULE"] = "schedule";
+})(ApiTriggerTypeQuery || (ApiTriggerTypeQuery = {}));
+export function apiTriggerTypeQueryToType(trigger) {
+    switch (trigger) {
+        case ApiTriggerTypeQuery.UI:
+            return ApiTriggerType.UI;
+        case ApiTriggerTypeQuery.WORKFLOW:
+            return ApiTriggerType.WORKFLOW;
+        case ApiTriggerTypeQuery.SCHEDULE:
+            return ApiTriggerType.SCHEDULE;
+    }
+}
+export function apiTriggerToEntity(trigger) {
+    switch (trigger) {
+        case ApiTriggerType.UI:
+            return EventEntityType.API;
+        case ApiTriggerType.WORKFLOW:
+            return EventEntityType.WORKFLOW;
+        case ApiTriggerType.SCHEDULE:
+            return EventEntityType.SCHEDULED_JOB;
+    }
+}
+export const EXPORTED_METADATA_EXCLUDED_FIELDS = ['description', 'folder', 'tags', 'timestamps', 'version'];
+export { ViewMode as OrchestratorViewMode } from '@superblocksteam/types';
+export * from './action';
+export * from './resolvedActionProp';
+export * from './schedule';
+export * from './execution';
+export * from './global';
+export * from './control-flow';
+//# sourceMappingURL=index.js.map

package/dist-esm/types/api/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/api/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AA+E3C,MAAM,CAAN,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,+CAAE,CAAA;IACF,2DAAQ,CAAA;IACR,2DAAQ,CAAA;AACV,CAAC,EAJW,cAAc,KAAd,cAAc,QAIzB;AAED,MAAM,CAAN,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,gCAAS,CAAA;IACT,4CAAqB,CAAA;IACrB,4CAAqB,CAAA;AACvB,CAAC,EAJW,mBAAmB,KAAnB,mBAAmB,QAI9B;AAED,MAAM,UAAU,yBAAyB,CAAC,OAA4B;IACpE,QAAQ,OAAO,EAAE;QACf,KAAK,mBAAmB,CAAC,EAAE;YACzB,OAAO,cAAc,CAAC,EAAE,CAAC;QAC3B,KAAK,mBAAmB,CAAC,QAAQ;YAC/B,OAAO,cAAc,CAAC,QAAQ,CAAC;QACjC,KAAK,mBAAmB,CAAC,QAAQ;YAC/B,OAAO,cAAc,CAAC,QAAQ,CAAC;KAClC;AACH,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,OAAuB;IACxD,QAAQ,OAAO,EAAE;QACf,KAAK,cAAc,CAAC,EAAE;YACpB,OAAO,eAAe,CAAC,GAAG,CAAC;QAC7B,KAAK,cAAc,CAAC,QAAQ;YAC1B,OAAO,eAAe,CAAC,QAAQ,CAAC;QAClC,KAAK,cAAc,CAAC,QAAQ;YAC1B,OAAO,eAAe,CAAC,aAAa,CAAC;KACxC;AACH,CAAC;AA4CD,MAAM,CAAC,MAAM,iCAAiC,GAAG,CAAC,aAAa,EAAE,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,SAAS,CAAU,CAAC;AA6BrH,OAAO,EAAE,QAAQ,IAAI,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC1E,cAAc,UAAU,CAAC;AACzB,cAAc,sBAAsB,CAAC;AACrC,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC"}

package/dist-esm/types/api/resolvedActionProp.d.ts

@@ -0,0 +1,17 @@
+/// <reference types="node" />
+export type TokenLocation = {
+    startOffset: number;
+    length: number;
+};
+export interface PlaceholderInfo {
+    /** the same placeholder (such as $1) might be used in multiple places so we need an array of locations here */
+    locations: TokenLocation[];
+    /** a textual representation of the bound value, possibly truncated (if it is too big) */
+    value: string;
+}
+export type PlaceholdersInfo = Record<string, PlaceholderInfo>;
+export interface ResolvedActionConfigurationProperty {
+    resolved: string | any[] | Buffer;
+    placeholdersInfo?: PlaceholdersInfo;
+}
+//# sourceMappingURL=resolvedActionProp.d.ts.map

package/dist-esm/types/api/resolvedActionProp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolvedActionProp.d.ts","sourceRoot":"","sources":["../../../src/types/api/resolvedActionProp.ts"],"names":[],"mappings":";AAAA,MAAM,MAAM,aAAa,GAAG;IAAE,WAAW,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC;AAEpE,MAAM,WAAW,eAAe;IAC9B,+GAA+G;IAC/G,SAAS,EAAE,aAAa,EAAE,CAAC;IAC3B,yFAAyF;IACzF,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;AAE/D,MAAM,WAAW,mCAAmC;IAElD,QAAQ,EAAE,MAAM,GAAG,GAAG,EAAE,GAAG,MAAM,CAAC;IAClC,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC"}

package/dist-esm/types/api/resolvedActionProp.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=resolvedActionProp.js.map

package/dist-esm/types/api/resolvedActionProp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolvedActionProp.js","sourceRoot":"","sources":["../../../src/types/api/resolvedActionProp.ts"],"names":[],"mappings":""}

package/dist-esm/types/api/schedule.d.ts

@@ -0,0 +1,35 @@
+export declare class ScheduleConfig {
+    frequency: number;
+    interval: Interval;
+    time: Date;
+    dayOfMonth: number;
+    daysOfWeek: boolean[];
+    timezoneLocale: string;
+    constructor({ frequency, interval, time, dayOfMonth, daysOfWeek, timezoneLocale: timezoneLocale }: {
+        frequency: number;
+        interval: Interval;
+        time: Date;
+        dayOfMonth: number;
+        daysOfWeek: boolean[];
+        timezoneLocale?: string;
+    });
+    static validate(config: ScheduleConfig): {
+        error: string | undefined;
+    };
+    static default(): ScheduleConfig;
+    private cronDaysOfWeek;
+    private getLocalMinutesAndHoursAndDays;
+    toCron(): string;
+}
+export declare enum Interval {
+    Minute = "minute",
+    Hour = "hour",
+    Day = "day",
+    Week = "week",
+    Month = "month"
+}
+export declare enum ScheduleState {
+    ACTIVE = 0,
+    PAUSED = 1
+}
+//# sourceMappingURL=schedule.d.ts.map

package/dist-esm/types/api/schedule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schedule.d.ts","sourceRoot":"","sources":["../../../src/types/api/schedule.ts"],"names":[],"mappings":"AAAA,qBAAa,cAAc;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,QAAQ,CAAC;IACnB,IAAI,EAAE,IAAI,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,OAAO,EAAE,CAAC;IAGtB,cAAc,EAAE,MAAM,CAAC;gBAEX,EACV,SAAS,EACT,QAAQ,EACR,IAAI,EACJ,UAAU,EACV,UAAU,EACV,cAAc,EAAE,cAAc,EAC/B,EAAE;QACD,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,QAAQ,CAAC;QACnB,IAAI,EAAE,IAAI,CAAC;QACX,UAAU,EAAE,MAAM,CAAC;QACnB,UAAU,EAAE,OAAO,EAAE,CAAC;QACtB,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;IASD,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,cAAc,GAAG;QAAE,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE;IAsBtE,MAAM,CAAC,OAAO,IAAI,cAAc;IAYhC,OAAO,CAAC,cAAc;IAKtB,OAAO,CAAC,8BAA8B;IAkBtC,MAAM,IAAI,MAAM;CAoBjB;AAED,oBAAY,QAAQ;IAClB,MAAM,WAAW;IACjB,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,KAAK,UAAU;CAChB;AAWD,oBAAY,aAAa;IACvB,MAAM,IAAA;IACN,MAAM,IAAA;CACP"}

package/dist-esm/types/api/schedule.js

@@ -0,0 +1,104 @@
+export class ScheduleConfig {
+    constructor({ frequency, interval, time, dayOfMonth, daysOfWeek, timezoneLocale: timezoneLocale }) {
+        this.frequency = frequency;
+        this.interval = interval;
+        this.time = time;
+        this.dayOfMonth = dayOfMonth;
+        this.daysOfWeek = daysOfWeek;
+        this.timezoneLocale = timezoneLocale || 'UTC';
+    }
+    static validate(config) {
+        const validIntervals = [Interval.Minute, Interval.Hour, Interval.Day, Interval.Week, Interval.Month];
+        if (!Number.isInteger(config.frequency)) {
+            return { error: 'Frequency should be an integer.' };
+        }
+        if (config.frequency < 0) {
+            return { error: 'Frequency should be greater than 0.' };
+        }
+        if (!validIntervals.includes(config.interval)) {
+            return { error: `Invalid interval ${config.interval}.` };
+        }
+        if (config.daysOfWeek.length !== 7) {
+            return { error: `Invalid interval config daysOfWeek. ${config.daysOfWeek}` };
+        }
+        if (!config.dayOfMonth || !Number.isInteger(config.dayOfMonth)) {
+            return { error: `Invalid dayOfMonth. ${config.dayOfMonth}` };
+        }
+        // TODO validate locale
+        return { error: undefined };
+    }
+    static default() {
+        return new ScheduleConfig({
+            frequency: 1,
+            interval: Interval.Month,
+            time: midnight(),
+            dayOfMonth: 1,
+            daysOfWeek: [true, false, false, false, false, false, false],
+            // In Server, this would resolve to UTC, in UI to the local timezone
+            timezoneLocale: Intl.DateTimeFormat().resolvedOptions().timeZone
+        });
+    }
+    cronDaysOfWeek() {
+        const selectedDays = this.daysOfWeek.flatMap((bool, index) => (bool ? index : []));
+        return selectedDays.length === 0 ? '*' : selectedDays.join(',');
+    }
+    getLocalMinutesAndHoursAndDays() {
+        // For historical reasons, we are saving the time in UTC. This is causing problem when we have DST changes
+        // Ideally, instead of storing a datetime object, we should store hours and minutes in the local timezone
+        // so that we can pass timezone to cron parser and it will take care of DST changes. This is basically
+        // equavelant to storing a cron spec. Which we should do in the future.
+        // For the time being, we are converting the time to the local timezone and then computing the minutes and hours
+        // Here is how it works:
+        //   * Get the local hours/minutes from the day the job was first created
+        //      -> /E.g. UTC 23:00 is 19:00 in New York during DST, 18:00 otherwise
+        //   * Add these local hours/minutes to cron expression
+        //   * Tell cron expression that we want next run in a specific timezone
+        //   * Cron expression decipher timezone and gives us a date which we store as UTC in Schedule table.
+        const localTime = new Date(this.time.toLocaleString('en', { timeZone: this.timezoneLocale }));
+        return [localTime.getMinutes(), localTime.getHours()];
+    }
+    // Currently, we use a cron evaluator to evaluate recurrence
+    // expressions.
+    toCron() {
+        const [localMinutes, localHours] = this.getLocalMinutesAndHoursAndDays();
+        switch (this.interval) {
+            case Interval.Minute:
+                // e.g. '*/2 * * *' -> every 2 minutes of the hour
+                return `*/${this.frequency} * * * *`;
+            case Interval.Hour:
+                // 'mm */2 * * *' -> every 2 hours every day at mm
+                return `${localMinutes} */${this.frequency} * * *`;
+            case Interval.Day:
+                // 'mm hh * * *' -> every day at hh:mm
+                return `${localMinutes} ${localHours} * * *`;
+            case Interval.Week:
+                // 'mm hh * * 0,2' -> every week at hh:mm on Sunday and Tuesday
+                return `${localMinutes} ${localHours} * * ${this.cronDaysOfWeek()}`;
+            case Interval.Month:
+                // 'mm hh dom */2 *' -> every 2 months on dom at hh:ss
+                return `${localMinutes} ${localHours} ${this.dayOfMonth} */${this.frequency} *`;
+        }
+    }
+}
+export var Interval;
+(function (Interval) {
+    Interval["Minute"] = "minute";
+    Interval["Hour"] = "hour";
+    Interval["Day"] = "day";
+    Interval["Week"] = "week";
+    Interval["Month"] = "month";
+})(Interval || (Interval = {}));
+const midnight = () => {
+    const d = new Date();
+    d.setHours(0);
+    d.setMinutes(0);
+    d.setSeconds(0);
+    d.setMilliseconds(0);
+    return d;
+};
+export var ScheduleState;
+(function (ScheduleState) {
+    ScheduleState[ScheduleState["ACTIVE"] = 0] = "ACTIVE";
+    ScheduleState[ScheduleState["PAUSED"] = 1] = "PAUSED";
+})(ScheduleState || (ScheduleState = {}));
+//# sourceMappingURL=schedule.js.map

package/dist-esm/types/api/schedule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schedule.js","sourceRoot":"","sources":["../../../src/types/api/schedule.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,cAAc;IAWzB,YAAY,EACV,SAAS,EACT,QAAQ,EACR,IAAI,EACJ,UAAU,EACV,UAAU,EACV,cAAc,EAAE,cAAc,EAQ/B;QACC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,cAAc,GAAG,cAAc,IAAI,KAAK,CAAC;IAChD,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,MAAsB;QACpC,MAAM,cAAc,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;QAErG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE;YACvC,OAAO,EAAE,KAAK,EAAE,iCAAiC,EAAE,CAAC;SACrD;QACD,IAAI,MAAM,CAAC,SAAS,GAAG,CAAC,EAAE;YACxB,OAAO,EAAE,KAAK,EAAE,qCAAqC,EAAE,CAAC;SACzD;QACD,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE;YAC7C,OAAO,EAAE,KAAK,EAAE,oBAAoB,MAAM,CAAC,QAAQ,GAAG,EAAE,CAAC;SAC1D;QACD,IAAI,MAAM,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;YAClC,OAAO,EAAE,KAAK,EAAE,uCAAuC,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC;SAC9E;QACD,IAAI,CAAC,MAAM,CAAC,UAAU,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE;YAC9D,OAAO,EAAE,KAAK,EAAE,uBAAuB,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC;SAC9D;QACD,uBAAuB;QACvB,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;IAC9B,CAAC;IAED,MAAM,CAAC,OAAO;QACZ,OAAO,IAAI,cAAc,CAAC;YACxB,SAAS,EAAE,CAAC;YACZ,QAAQ,EAAE,QAAQ,CAAC,KAAK;YACxB,IAAI,EAAE,QAAQ,EAAE;YAChB,UAAU,EAAE,CAAC;YACb,UAAU,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;YAC5D,oEAAoE;YACpE,cAAc,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,eAAe,EAAE,CAAC,QAAQ;SACjE,CAAC,CAAC;IACL,CAAC;IAEO,cAAc;QACpB,MAAM,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACnF,OAAO,YAAY,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAClE,CAAC;IAEO,8BAA8B;QACpC,0GAA0G;QAC1G,yGAAyG;QACzG,sGAAsG;QACtG,uEAAuE;QACvE,gHAAgH;QAChH,wBAAwB;QACxB,yEAAyE;QACzE,2EAA2E;QAC3E,uDAAuD;QACvD,wEAAwE;QACxE,qGAAqG;QACrG,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;QAC9F,OAAO,CAAC,SAAS,CAAC,UAAU,EAAE,EAAE,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;IACxD,CAAC;IAED,4DAA4D;IAC5D,eAAe;IACf,MAAM;QACJ,MAAM,CAAC,YAAY,EAAE,UAAU,CAAC,GAAG,IAAI,CAAC,8BAA8B,EAAE,CAAC;QACzE,QAAQ,IAAI,CAAC,QAAQ,EAAE;YACrB,KAAK,QAAQ,CAAC,MAAM;gBAClB,kDAAkD;gBAClD,OAAO,KAAK,IAAI,CAAC,SAAS,UAAU,CAAC;YACvC,KAAK,QAAQ,CAAC,IAAI;gBAChB,kDAAkD;gBAClD,OAAO,GAAG,YAAY,MAAM,IAAI,CAAC,SAAS,QAAQ,CAAC;YACrD,KAAK,QAAQ,CAAC,GAAG;gBACf,sCAAsC;gBACtC,OAAO,GAAG,YAAY,IAAI,UAAU,QAAQ,CAAC;YAC/C,KAAK,QAAQ,CAAC,IAAI;gBAChB,+DAA+D;gBAC/D,OAAO,GAAG,YAAY,IAAI,UAAU,QAAQ,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC;YACtE,KAAK,QAAQ,CAAC,KAAK;gBACjB,sDAAsD;gBACtD,OAAO,GAAG,YAAY,IAAI,UAAU,IAAI,IAAI,CAAC,UAAU,MAAM,IAAI,CAAC,SAAS,IAAI,CAAC;SACnF;IACH,CAAC;CACF;AAED,MAAM,CAAN,IAAY,QAMX;AAND,WAAY,QAAQ;IAClB,6BAAiB,CAAA;IACjB,yBAAa,CAAA;IACb,uBAAW,CAAA;IACX,yBAAa,CAAA;IACb,2BAAe,CAAA;AACjB,CAAC,EANW,QAAQ,KAAR,QAAQ,QAMnB;AAED,MAAM,QAAQ,GAAG,GAAS,EAAE;IAC1B,MAAM,CAAC,GAAG,IAAI,IAAI,EAAE,CAAC;IACrB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IACd,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAChB,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAChB,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IACrB,OAAO,CAAC,CAAC;AACX,CAAC,CAAC;AAEF,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,qDAAM,CAAA;IACN,qDAAM,CAAA;AACR,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB"}