attlaz-client 1.63.1 → 1.64.0

package/dist/Client.d.ts

@@ -8,6 +8,7 @@ import { ChannelEndpoint } from './Service/ChannelEndpoint.js';
 import { CodeDeployEndpoint } from './Service/CodeDeployEndpoint.js';
 import { CodeSourceStrategiesEndpoint } from './Service/CodeSourceStrategiesEndpoint.js';
 import { CollectionsEndpoint } from './Service/CollectionsEndpoint.js';
+import { CommandExecutionEndpoint } from './Service/CommandExecutionEndpoint.js';
 import { ConfigEndpoint } from './Service/ConfigEndpoint.js';
 import { ConfigurationEndpoint } from './Service/ConfigurationEndpoint.js';
 import { FirewallEndpoint } from './Service/FirewallEndpoint.js';
@@ -95,6 +96,7 @@ export declare class Client {
     getCodeSourceStrategiesEndpoint(): CodeSourceStrategiesEndpoint;
     getSearchEndpoint(): SearchEndpoint;
     getUserActionEndpoint(): UserActionEndpoint;
+    getCommandExecutionEndpoint(): CommandExecutionEndpoint;
     getAccessTokenEndpoint(): AccessTokenEndpoint;
     getCollectionsEndpoint(): CollectionsEndpoint;
     getRunnerPoolEndpoint(): RunnerPoolEndpoint;

package/dist/Client.js

@@ -8,6 +8,7 @@ import { ChannelEndpoint } from './Service/ChannelEndpoint.js';
 import { CodeDeployEndpoint } from './Service/CodeDeployEndpoint.js';
 import { CodeSourceStrategiesEndpoint } from './Service/CodeSourceStrategiesEndpoint.js';
 import { CollectionsEndpoint } from './Service/CollectionsEndpoint.js';
+import { CommandExecutionEndpoint } from './Service/CommandExecutionEndpoint.js';
 import { ConfigEndpoint } from './Service/ConfigEndpoint.js';
 import { ConfigurationEndpoint } from './Service/ConfigurationEndpoint.js';
 import { FirewallEndpoint } from './Service/FirewallEndpoint.js';
@@ -46,6 +47,7 @@ export class Client {
         ChannelEndpoint,
         CodeDeployEndpoint,
         CodeSourceStrategiesEndpoint,
+        CommandExecutionEndpoint,
         ConfigEndpoint,
         FirewallEndpoint,
         FlowEndpoint,
@@ -231,6 +233,9 @@ export class Client {
     getUserActionEndpoint() {
         return this.getEndpoint('useraction', this.Store.UserActionEndpoint);
     }
+    getCommandExecutionEndpoint() {
+        return this.getEndpoint('commandexecution', this.Store.CommandExecutionEndpoint);
+    }
     getAccessTokenEndpoint() {
         return this.getEndpoint('accesstoken', this.Store.AccessTokenEndpoint);
     }

package/dist/Model/AccessToken/UserAccessTokenStatus.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Display/filter status of a user API key. Mirrors the server enum
+ * (Library/Core Attlaz-OAuth/Model/UserAccessTokenStatus). Folds the derived "expired" concept
+ * (computed from the expiry date, not stored) on top of the stored state.
+ */
+export declare enum UserAccessTokenStatus {
+    Active = "active",
+    Inactive = "inactive",
+    Expired = "expired",
+    Revoked = "revoked"
+}

package/dist/Model/AccessToken/UserAccessTokenStatus.js

@@ -0,0 +1,12 @@
+/**
+ * Display/filter status of a user API key. Mirrors the server enum
+ * (Library/Core Attlaz-OAuth/Model/UserAccessTokenStatus). Folds the derived "expired" concept
+ * (computed from the expiry date, not stored) on top of the stored state.
+ */
+export var UserAccessTokenStatus;
+(function (UserAccessTokenStatus) {
+    UserAccessTokenStatus["Active"] = "active";
+    UserAccessTokenStatus["Inactive"] = "inactive";
+    UserAccessTokenStatus["Expired"] = "expired";
+    UserAccessTokenStatus["Revoked"] = "revoked";
+})(UserAccessTokenStatus || (UserAccessTokenStatus = {}));

package/dist/Model/Adapter/AdapterConnection.js

@@ -18,7 +18,7 @@ export class AdapterConnection extends MetaDataAware {
         adapterConnection.projectId = rawAdapterConnection.project;
         adapterConnection.state = State.fromString(rawAdapterConnection.state);
         adapterConnection.status = AdapterConnectionStatus.fromString(rawAdapterConnection.status);
-        adapterConnection.lastUsedAt = (rawAdapterConnection.last_used === null || rawAdapterConnection.last_used === undefined) ? null : Utils.parseRawDate(rawAdapterConnection.last_used);
+        adapterConnection.lastUsedAt = (rawAdapterConnection.last_used_at === null || rawAdapterConnection.last_used_at === undefined) ? null : Utils.parseRawDate(rawAdapterConnection.last_used_at);
         return adapterConnection;
     }
 }

package/dist/Model/Command/CommandExecutionFilter.d.ts

@@ -0,0 +1,6 @@
+import { CommandExecutionStatus } from './CommandExecutionStatus.js';
+export interface CommandExecutionFilter {
+    status?: CommandExecutionStatus;
+    type?: string;
+    requestedBy?: string;
+}

package/dist/Model/Command/CommandExecutionFilter.js

@@ -0,0 +1 @@
+export {};

package/dist/Model/Command/CommandExecutionHistory.d.ts

@@ -0,0 +1,15 @@
+import { DataValueCollection } from '../DataValueCollection.js';
+import { CommandExecutionStatus } from './CommandExecutionStatus.js';
+export declare class CommandExecutionHistory {
+    id: string;
+    commandType: string;
+    commandTime: Date;
+    commandData: DataValueCollection;
+    commandVersion: string;
+    requestedBy: string;
+    executionStarted: Date | null;
+    executionFinished: Date | null;
+    executionStatus: CommandExecutionStatus;
+    executionError: string | null;
+    executionResult: string | null;
+}

package/dist/Model/Command/CommandExecutionHistory.js

@@ -0,0 +1,15 @@
+export class CommandExecutionHistory {
+    id;
+    commandType;
+    commandTime;
+    commandData;
+    commandVersion;
+    // The user that requested the command (the platform system user for cron/event/maintenance commands).
+    requestedBy;
+    executionStarted;
+    executionFinished;
+    executionStatus;
+    executionError;
+    // Structured result payload as a JSON string (e.g. '{"removedCount": 1234}'); shape depends on the command type.
+    executionResult;
+}

package/dist/Model/Command/CommandExecutionStatus.d.ts

@@ -0,0 +1,9 @@
+export declare enum CommandExecutionStatus {
+    Pending = "pending",
+    Running = "running",
+    Completed = "completed",
+    Failed = "failed"
+}
+export declare namespace CommandExecutionStatus {
+    const fromString: (input: string) => CommandExecutionStatus;
+}

package/dist/Model/Command/CommandExecutionStatus.js

@@ -0,0 +1,20 @@
+export var CommandExecutionStatus;
+(function (CommandExecutionStatus) {
+    CommandExecutionStatus["Pending"] = "pending";
+    CommandExecutionStatus["Running"] = "running";
+    CommandExecutionStatus["Completed"] = "completed";
+    CommandExecutionStatus["Failed"] = "failed";
+})(CommandExecutionStatus || (CommandExecutionStatus = {}));
+(function (CommandExecutionStatus) {
+    CommandExecutionStatus.fromString = (input) => {
+        switch (input) {
+            case CommandExecutionStatus.Pending:
+            case CommandExecutionStatus.Running:
+            case CommandExecutionStatus.Completed:
+            case CommandExecutionStatus.Failed:
+                return input;
+            default:
+                throw new Error('Unknown CommandExecutionStatus "' + input + '"');
+        }
+    };
+})(CommandExecutionStatus || (CommandExecutionStatus = {}));

package/dist/Model/ProviderToken/ProviderTokenAccessToken.d.ts

@@ -1,5 +1,6 @@
 import { ApiRecord } from '../ApiRecord.js';
 export declare class ProviderTokenAccessToken {
     accessToken: string;
+    expiresAt: Date | null;
     static parse(rawToken: ApiRecord): ProviderTokenAccessToken;
 }

package/dist/Model/ProviderToken/ProviderTokenAccessToken.js

@@ -1,8 +1,11 @@
 export class ProviderTokenAccessToken {
     accessToken;
+    // When the access token expires — lets callers cache it for the run instead of re-fetching per call.
+    expiresAt = null;
     static parse(rawToken) {
         const token = new ProviderTokenAccessToken();
         token.accessToken = rawToken.access_token;
+        token.expiresAt = rawToken.expires_at !== undefined && rawToken.expires_at !== null ? new Date(rawToken.expires_at) : null;
         return token;
     }
 }

package/dist/Service/AccessTokenEndpoint.d.ts

@@ -1,9 +1,10 @@
 import { CollectionResult } from '../Model/Result/CollectionResult.js';
 import { CursorPagination } from '../Model/Pagination/CursorPagination.js';
 import { UserAccessToken } from '../Model/AccessToken/UserAccessToken.js';
+import { UserAccessTokenStatus } from '../Model/AccessToken/UserAccessTokenStatus.js';
 import { Endpoint } from './Endpoint.js';
 export declare class AccessTokenEndpoint extends Endpoint {
-    getByUser(pagination: CursorPagination): Promise<CollectionResult<UserAccessToken>>;
+    getByUser(pagination: CursorPagination, status?: UserAccessTokenStatus | null): Promise<CollectionResult<UserAccessToken>>;
     create(name: string, scopes: string[], expiresAt: Date): Promise<UserAccessToken>;
     update(tokenId: string, name: string, scopes: string[]): Promise<UserAccessToken>;
     revoke(tokenId: string): Promise<boolean>;

package/dist/Service/AccessTokenEndpoint.js

@@ -2,9 +2,12 @@ import { QueryString } from '../Http/Data/QueryString.js';
 import { UserAccessToken } from '../Model/AccessToken/UserAccessToken.js';
 import { Endpoint } from './Endpoint.js';
 export class AccessTokenEndpoint extends Endpoint {
-    async getByUser(pagination) {
+    async getByUser(pagination, status = null) {
         const queryString = new QueryString('/access-tokens');
         queryString.addPagination(pagination);
+        if (status !== null) {
+            queryString.set('status', status);
+        }
         try {
             const result = await this.requestCollection(queryString, UserAccessToken.parse);
             return result;

package/dist/Service/CommandExecutionEndpoint.d.ts

@@ -0,0 +1,10 @@
+import { CommandExecutionFilter } from '../Model/Command/CommandExecutionFilter.js';
+import { CommandExecutionHistory } from '../Model/Command/CommandExecutionHistory.js';
+import { CursorPagination } from '../Model/Pagination/CursorPagination.js';
+import { CollectionResult } from '../Model/Result/CollectionResult.js';
+import { Endpoint } from './Endpoint.js';
+export declare class CommandExecutionEndpoint extends Endpoint {
+    getAll(pagination?: CursorPagination | null, filter?: CommandExecutionFilter | null): Promise<CollectionResult<CommandExecutionHistory>>;
+    getById(id: string): Promise<CommandExecutionHistory | null>;
+    private static parse;
+}

package/dist/Service/CommandExecutionEndpoint.js

@@ -0,0 +1,44 @@
+import { QueryString } from '../Http/Data/QueryString.js';
+import { CommandExecutionHistory } from '../Model/Command/CommandExecutionHistory.js';
+import { CommandExecutionStatus } from '../Model/Command/CommandExecutionStatus.js';
+import { DataValueCollection } from '../Model/DataValueCollection.js';
+import { Utils } from '../Utils.js';
+import { Endpoint } from './Endpoint.js';
+export class CommandExecutionEndpoint extends Endpoint {
+    async getAll(pagination = null, filter = null) {
+        const queryString = new QueryString('/system/command-executions');
+        queryString.addPagination(pagination);
+        if (filter !== null) {
+            if (filter.status !== undefined) {
+                queryString.set('status', filter.status);
+            }
+            if (filter.type !== undefined) {
+                queryString.set('type', filter.type);
+            }
+            if (filter.requestedBy !== undefined) {
+                queryString.set('requested_by', filter.requestedBy);
+            }
+        }
+        return await this.requestCollection(queryString, CommandExecutionEndpoint.parse, null, 'GET');
+    }
+    async getById(id) {
+        const queryString = new QueryString('/system/command-executions/' + id);
+        const result = await this.requestObject(queryString, null, CommandExecutionEndpoint.parse, 'GET');
+        return result.getData();
+    }
+    static parse(raw) {
+        const history = new CommandExecutionHistory();
+        history.id = raw.id;
+        history.commandType = raw.command_type;
+        history.commandTime = Utils.parseRawDate(raw.command_time);
+        history.commandData = DataValueCollection.fromObject(raw.command_data);
+        history.commandVersion = raw.command_version;
+        history.requestedBy = raw.requested_by;
+        history.executionStarted = (raw.execution_started === null || raw.execution_started === undefined) ? null : Utils.parseRawDate(raw.execution_started);
+        history.executionFinished = (raw.execution_finished === null || raw.execution_finished === undefined) ? null : Utils.parseRawDate(raw.execution_finished);
+        history.executionStatus = CommandExecutionStatus.fromString(raw.execution_status);
+        history.executionError = raw.execution_error ?? null;
+        history.executionResult = raw.execution_result ?? null;
+        return history;
+    }
+}

package/dist/index.d.ts

@@ -24,6 +24,7 @@ export { LoadAllHelper } from './Helper/LoadAllHelper.js';
  * Models
  */
 export { UserAccessToken } from './Model/AccessToken/UserAccessToken.js';
+export { UserAccessTokenStatus } from './Model/AccessToken/UserAccessTokenStatus.js';
 export { Adapter } from './Model/Adapter/Adapter.js';
 export { AdapterConfiguration } from './Model/Adapter/AdapterConfiguration.js';
 export { AdapterConnection } from './Model/Adapter/AdapterConnection.js';
@@ -127,6 +128,9 @@ export { User } from './Model/User/User.js';
 export { UserAuthProvider } from './Model/User/UserAuthProvider.js';
 export { UserAction } from './Model/User/UserAction.js';
 export { RunnerImage } from './Model/Runner/RunnerImage.js';
+export { CommandExecutionHistory } from './Model/Command/CommandExecutionHistory.js';
+export { CommandExecutionStatus } from './Model/Command/CommandExecutionStatus.js';
+export { CommandExecutionFilter } from './Model/Command/CommandExecutionFilter.js';
 export { Endpoint } from './Service/Endpoint.js';
 export { AdapterEndpoint } from './Service/AdapterEndpoint.js';
 export { AdapterConnectionEndpoint } from './Service/AdapterConnectionEndpoint.js';

package/dist/index.js

@@ -17,6 +17,7 @@ export { LoadAllHelper } from './Helper/LoadAllHelper.js';
  * Models
  */
 export { UserAccessToken } from './Model/AccessToken/UserAccessToken.js';
+export { UserAccessTokenStatus } from './Model/AccessToken/UserAccessTokenStatus.js';
 export { Adapter } from './Model/Adapter/Adapter.js';
 export { AdapterConfiguration } from './Model/Adapter/AdapterConfiguration.js';
 export { AdapterConnection } from './Model/Adapter/AdapterConnection.js';
@@ -115,6 +116,8 @@ export { User } from './Model/User/User.js';
 export { UserAuthProvider } from './Model/User/UserAuthProvider.js';
 export { UserAction } from './Model/User/UserAction.js';
 export { RunnerImage } from './Model/Runner/RunnerImage.js';
+export { CommandExecutionHistory } from './Model/Command/CommandExecutionHistory.js';
+export { CommandExecutionStatus } from './Model/Command/CommandExecutionStatus.js';
 export { Endpoint } from './Service/Endpoint.js';
 /* Endpoints */
 export { AdapterEndpoint } from './Service/AdapterEndpoint.js';

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "1.63.0";
+export declare const VERSION = "1.64.0";

package/dist/version.js

@@ -1 +1 @@
-export const VERSION = "1.63.0";
+export const VERSION = "1.64.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "attlaz-client",
-  "version": "1.63.1",
+  "version": "1.64.0",
   "description": "Javascript Client to access Attlaz API",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",