anbaric-tsapi 1.21.4 → 1.22.0

package/src/api/jobs/JobPersistence.ts

@@ -1,141 +0,0 @@
-import {Actor} from "../actors/Actor";
-import {Auditor} from "../auditing/Auditor";
-import {Job} from "./Job";
-import {serializeWaitForInput} from "../actions/WaitForInput";
-import {currentAppId} from "../cloud/AppAware";
-
-/* Persists jobs and audits every interaction. Public methods record the
-   interaction against the injected auditor and then defer to the abstract
-   ...Internal methods a concrete store implements. */
-abstract class JobPersistence {
-
-    constructor(protected auditor : Auditor) {
-    }
-
-    async create(actor : Actor,
-               job : Job) : Promise<void> {
-
-        await this.auditor.audit(job.appId, "job", job.id, actor, [JobPersistence.Interaction.CREATE], "Job created", job);
-
-        this.saveInternal(job);
-    }
-
-    async save(actor : Actor,
-               changeDescription : string,
-               job : Job,
-               properties? : Map<string, any>,
-               state? : string) : Promise<void> {
-
-        const change : { properties? : any, state? : any, metadata? : Record<string, any> } = {
-            properties: properties ? this.generatePropertiesDiff(job.properties, properties) : undefined,
-            state: state ? {from : job.state, to : state} : undefined
-        }
-
-        const interaction : Array<string> = [];
-        if (properties) interaction.push(JobPersistence.Interaction.UPDATE_PROPERTIES);
-        if (state) interaction.push(JobPersistence.Interaction.CHANGE_STATE);
-        if (job.status === Job.Status.AWAITING_INPUT && job.awaitMetadata) {
-            interaction.push(JobPersistence.Interaction.AWAIT);
-            change.metadata = serializeWaitForInput(job.awaitMetadata);
-        }
-
-        await this.auditor.audit(job.appId, "job", job.id, actor, interaction, changeDescription, change);
-
-        const updatedJob = new Job(
-            job.id,
-            properties ? this.updateProperties(job.properties, properties) : job.properties,
-            state ? state : job.state,
-            job.workflowId,
-            job.appId,
-            job.startedBy,
-            job.startedAt,
-            new Date(),
-            job.killed,
-            job.status,
-            job.awaitMetadata,
-            job.waitingFor
-        )
-
-        this.saveInternal(updatedJob);
-    }
-
-    async kill(id : string, actor : Actor) : Promise<void> {
-        await this.auditor.audit(currentAppId(), "job", id, actor, [JobPersistence.Interaction.KILL], "Job killed", null);
-        await this.killInternal(id);
-    }
-
-    async killOlderThan(lastUpdatedBefore : Date, actor : Actor) : Promise<number> {
-        await this.auditor.audit(currentAppId(), "job", "*", actor, [JobPersistence.Interaction.KILL],
-            `Jobs not updated since ${lastUpdatedBefore.toISOString()} killed`, null);
-        return this.killOlderThanInternal(lastUpdatedBefore);
-    }
-
-    async countByState(actor : Actor) : Promise<Array<JobPersistence.StateCount>> {
-        await this.auditor.audit(currentAppId(), "job", "*", actor, [JobPersistence.Interaction.LIST], "", null);
-        return this.countByStateInternal();
-    }
-
-    private generatePropertiesDiff(oldVersion : Map<string, any>, newVersion : Map<string, any>) : Map<string, {from: any, to: any}> {
-        const diff: Map<string, { from: any; to: any; }> = new Map();
-
-        for (const [key, value] of newVersion) {
-            diff.set(key, {from: oldVersion.get(key), to: value});
-        }
-        return diff;
-    }
-
-    private updateProperties(oldVersion : Map<string, any>, newVersion : Map<string, any>) : Map<string, any> {
-        const updated = new Map(oldVersion);
-        for (const [key, value] of newVersion) {
-            updated.set(key, value);
-        }
-        return updated;
-    }
-
-    async retrieve(id : string, actor : Actor) : Promise<Job> {
-        await this.auditor.audit(currentAppId(), "job", id, actor, [JobPersistence.Interaction.READ], "", null);
-        return this.retrieveInternal(id);
-    }
-
-    async delete(id : string, actor : Actor) : Promise<void> {
-        await this.auditor.audit(currentAppId(), "job", id, actor, [JobPersistence.Interaction.DELETE], "", null);
-        await this.deleteInternal(id);
-    }
-
-    async list(actor : Actor, pageSize? : number, page? : number) : Promise<Array<Job>> {
-        await this.auditor.audit(currentAppId(), "job", "*", actor, [JobPersistence.Interaction.LIST], "", null);
-        return this.listInternal(pageSize, page);
-    }
-
-    protected abstract saveInternal(job : Job) : Promise<void>;
-    protected abstract retrieveInternal(id : string) : Promise<Job>;
-    protected abstract deleteInternal(id : string) : Promise<void>;
-    protected abstract listInternal(pageSize? : number, page? : number) : Promise<Array<Job>>;
-    protected abstract killInternal(id : string) : Promise<void>;
-    protected abstract killOlderThanInternal(lastUpdatedBefore : Date) : Promise<number>;
-    protected abstract countByStateInternal() : Promise<Array<JobPersistence.StateCount>>;
-
-}
-
-namespace JobPersistence {
-
-    export enum Interaction {
-        CREATE = "CREATE",
-        UPDATE_PROPERTIES = "UPDATE_PROPERTIES",
-        CHANGE_STATE = "CHANGE_STATE",
-        AWAIT = "AWAIT",
-        DELETE = "DELETE",
-        READ = "READ",
-        LIST = "LIST",
-        KILL = "KILL",
-    }
-
-    export type StateCount = {
-        state : string,
-        killed : boolean,
-        count : number,
-    };
-
-}
-
-export { JobPersistence }

package/src/api/jobs/JobSerialization.ts

@@ -1,45 +0,0 @@
-import {Job} from "./Job";
-import {SerializedWaitForInput, serializeWaitForInput, deserializeWaitForInput} from "../actions/WaitForInput";
-
-type SerializedJob = {
-    id : string,
-    state : string,
-    properties : Record<string, any>,
-    workflowId? : string,
-    appId? : string,
-    startedAt? : string,
-    startedBy? : string,
-    lastUpdated? : string,
-    killed? : boolean,
-    status? : string,
-    waitingFor? : string,
-    awaitMetadata? : SerializedWaitForInput,
-};
-
-const serializeJob = (job : Job) : SerializedJob => ({
-    id: job.id,
-    state: job.state,
-    properties: Object.fromEntries(job.properties),
-    workflowId: job.workflowId,
-    appId: job.appId,
-    startedAt: job.startedAt.toISOString(),
-    startedBy: job.startedBy,
-    lastUpdated: job.lastUpdated.toISOString(),
-    killed: job.killed,
-    status: job.status,
-    waitingFor: job.waitingFor,
-    awaitMetadata: job.awaitMetadata ? serializeWaitForInput(job.awaitMetadata) : undefined,
-});
-
-const deserializeJob = (serialized : SerializedJob) : Job => {
-    const startedAt = serialized.startedAt ? new Date(serialized.startedAt) : new Date();
-    return new Job(serialized.id, new Map(Object.entries(serialized.properties)), serialized.state,
-        serialized.workflowId, serialized.appId, serialized.startedBy ?? "system", startedAt,
-        serialized.lastUpdated ? new Date(serialized.lastUpdated) : startedAt, serialized.killed ?? false,
-        serialized.status ?? Job.Status.ACTIVE,
-        serialized.awaitMetadata ? deserializeWaitForInput(serialized.awaitMetadata) : undefined,
-        serialized.waitingFor);
-};
-
-export { serializeJob, deserializeJob };
-export type { SerializedJob };

package/src/api/jobs/PropertyDefinition.ts

@@ -1,12 +0,0 @@
-class PropertyDefinition {
-
-    id : string;
-    required : boolean = false;
-    validation : (arg0: any) => boolean = (value : any) => true;
-
-    constructor(id : string) {
-        this.id = id;
-    }
-}
-
-export { PropertyDefinition }

package/src/api/secrets/SecretStore.ts

@@ -1,57 +0,0 @@
-import {Actor} from "../actors/Actor";
-import {Auditor} from "../auditing/Auditor";
-import {currentAppId} from "../cloud/AppAware";
-
-/* Stores named secrets and audits every interaction. The secret value is
-   never included in an audit record. Public methods audit then defer to the
-   abstract ...Internal methods. */
-abstract class SecretStore {
-
-    constructor(protected auditor : Auditor) {
-    }
-
-    async create(actor : Actor, name : string, value : string) : Promise<void> {
-        await this.auditor.audit(currentAppId(), "secret", name, actor, [SecretStore.Interaction.CREATE], "Secret created", null);
-        await this.saveInternal(name, value);
-    }
-
-    async save(actor : Actor, changeDescription : string, name : string, value : string) : Promise<void> {
-        await this.auditor.audit(currentAppId(), "secret", name, actor, [SecretStore.Interaction.SAVE], changeDescription, null);
-        await this.saveInternal(name, value);
-    }
-
-    async retrieve(name : string, actor : Actor) : Promise<string> {
-        await this.auditor.audit(currentAppId(), "secret", name, actor, [SecretStore.Interaction.READ], "", null);
-        return this.retrieveInternal(name);
-    }
-
-    async delete(name : string, actor : Actor) : Promise<void> {
-        await this.auditor.audit(currentAppId(), "secret", name, actor, [SecretStore.Interaction.DELETE], "", null);
-        await this.deleteInternal(name);
-    }
-
-    async list(actor : Actor) : Promise<Array<string>> {
-        await this.auditor.audit(currentAppId(), "secret", "*", actor, [SecretStore.Interaction.LIST], "", null);
-        return this.listInternal();
-    }
-
-    protected abstract saveInternal(name : string, value : string) : Promise<void>;
-    protected abstract retrieveInternal(name : string) : Promise<string>;
-    protected abstract deleteInternal(name : string) : Promise<void>;
-    protected abstract listInternal() : Promise<Array<string>>;
-
-}
-
-namespace SecretStore {
-
-    export enum Interaction {
-        CREATE = "CREATE",
-        SAVE = "SAVE",
-        READ = "READ",
-        DELETE = "DELETE",
-        LIST = "LIST",
-    }
-
-}
-
-export { SecretStore }

package/src/api/sessions/SessionResolver.ts

@@ -1,20 +0,0 @@
-/* The identity behind a platform session token, as resolved by the platform. */
-type ResolvedSession = {
-
-    id : string,
-    roles : Array<string>,
-    tenant? : string,
-
-};
-
-/* Resolves a platform session token (the anbaric_session cookie) into the
-   user's identity. A deployed app cannot verify the token itself - it is signed
-   with a platform-only secret - so the resolution is a call to the platform.
-   Returns undefined when the token is missing, invalid or expired. */
-interface SessionResolver {
-
-    resolve(sessionToken : string) : Promise<ResolvedSession | undefined>;
-
-}
-
-export type { SessionResolver, ResolvedSession }

package/src/api/sql/SqlStore.ts

@@ -1,41 +0,0 @@
-import {Actor} from "../actors/Actor";
-import {Auditor} from "../auditing/Auditor";
-import {currentAppId} from "../cloud/AppAware";
-
-/* A relational (SQL) store for application data. Public methods audit the
-   interaction then defer to the abstract ...Internal. `query` returns rows;
-   `execute` runs a statement and returns the number of affected rows. The
-   backing engine (SQLite locally, PostgreSQL in the cloud) is chosen by the
-   factory; SQL placeholder syntax differs between them (see the docs). */
-abstract class SqlStore {
-
-    constructor(protected auditor : Auditor) {
-    }
-
-    async query(actor : Actor, sql : string, parameters : Array<any> = []) : Promise<Array<Record<string, any>>> {
-        await this.auditor.audit(currentAppId(), "sql", "*", actor, [SqlStore.Interaction.QUERY], sql, null);
-        return this.queryInternal(sql, parameters);
-    }
-
-    async execute(actor : Actor, sql : string, parameters : Array<any> = []) : Promise<number> {
-        await this.auditor.audit(currentAppId(), "sql", "*", actor, [SqlStore.Interaction.EXECUTE], sql, null);
-        return this.executeInternal(sql, parameters);
-    }
-
-    abstract close() : Promise<void>;
-
-    protected abstract queryInternal(sql : string, parameters : Array<any>) : Promise<Array<Record<string, any>>>;
-    protected abstract executeInternal(sql : string, parameters : Array<any>) : Promise<number>;
-
-}
-
-namespace SqlStore {
-
-    export enum Interaction {
-        QUERY = "QUERY",
-        EXECUTE = "EXECUTE",
-    }
-
-}
-
-export { SqlStore }

package/src/api/state-machine/Consumer.ts

@@ -1,8 +0,0 @@
-interface Consumer {
-
-    subscribe(appId : string | undefined, workflowId : string, processJob : (jobId : string) => Promise<void>) : void;
-    cleanUp() : Promise<void>;
-
-}
-
-export { Consumer }

package/src/api/state-machine/Queue.ts

@@ -1,22 +0,0 @@
-import {QueueMessage} from "../cloud/QueueMessage";
-
-interface Queue {
-
-    enqueue(jobId : string, appId : string | undefined, workflowId : string) : Promise<void>;
-    schedule(jobId : string, appId : string | undefined, workflowId : string, due : Date) : Promise<void>;
-
-}
-
-interface Dequeue extends Queue {
-
-    dequeueSome() : Promise<Array<QueueMessage>>;
-
-}
-
-const Dequeue = {
-    supports(queue : Queue) : queue is Dequeue {
-        return "dequeueSome" in queue;
-    },
-};
-
-export { Queue, Dequeue }

package/src/api/states/State.ts

@@ -1,25 +0,0 @@
-import {Action} from "../actions/Action";
-import {Await} from "../actions/Await";
-import {Transition} from "../transitions/Transition";
-
-class State {
-
-    readonly id : string;
-    actions : Array<Action | Await>;
-    transitions : Array<Transition>;
-    readonly isTerminal : boolean;
-
-    constructor(id : string, actions : Array<Action | Await> = [], transitions : Array<Transition> = [], isTerminal : boolean = false) {
-        this.id = id;
-        this.actions = actions;
-        this.transitions = transitions;
-        this.isTerminal = isTerminal;
-    }
-
-    subscribe(action : Action | Await) : void {
-        this.actions.push(action);
-    }
-
-}
-
-export { State }

package/src/api/states/Terminal.ts

@@ -1,25 +0,0 @@
-import {State} from "./State";
-
-/* An end state: a job that reaches a Terminal stops progressing and is never
-   re-enqueued. The outcome records whether the workflow succeeded or failed. */
-class Terminal extends State {
-
-    readonly outcome : Terminal.Outcome;
-
-    constructor(id : string, outcome : Terminal.Outcome) {
-        super(id, [], [], true);
-        this.outcome = outcome;
-    }
-
-}
-
-namespace Terminal {
-
-    export enum Outcome {
-        SUCCESS = "SUCCESS",
-        FAILURE = "FAILURE",
-    }
-
-}
-
-export { Terminal }

package/src/api/transitions/Transition.ts

@@ -1,13 +0,0 @@
-import {Job} from "../jobs/Job";
-
-class Transition {
-    to: string;
-    predicate: (job: Job) => boolean;
-
-    constructor(to: string, predicate: (job: Job) => boolean) {
-        this.to = to;
-        this.predicate = predicate;
-    }
-}
-
-export { Transition }

package/src/index.ts

@@ -1,29 +0,0 @@
-export * from "./api/jobs/Job";
-export * from "./api/jobs/JobPersistence"
-export * from "./api/jobs/JobSerialization"
-export * from "./api/jobs/PropertyDefinition"
-export * from "./api/states/State"
-export * from "./api/states/Terminal"
-export * from "./api/actions/Action"
-export * from "./api/actions/Await"
-export * from "./api/actions/WaitForInput"
-export * from "./api/actions/AgenticAction"
-export * from "./api/actors/agents/AgentMessage"
-export * from "./api/actors/agents/AgentRequest"
-export * from "./api/actors/agents/Agent"
-export * from "./api/auditing/Auditor"
-export * from "./api/auditing/NoOpAuditor"
-export * from "./api/transitions/Transition"
-export * from "./api/actors/Actor"
-export * from "./api/actors/SystemActor"
-export * from "./api/sessions/SessionResolver"
-export * from "./api/documents/JsonStore"
-export * from "./api/secrets/SecretStore"
-export * from "./api/sql/SqlStore"
-export * from "./api/documents/JsonSchema"
-export * from "./api/state-machine/Queue"
-export * from "./api/state-machine/Consumer"
-export * from "./api/cloud/QueueMessage"
-export * from "./api/cloud/WorkflowDefinition"
-export * from "./api/cloud/AuditRecord"
-export * from "./api/cloud/AppAware"