@keboola/api-fixtures 26.0.0 → 28.0.0

package/dist/index.d.cts

@@ -1,6 +1,7 @@
 import { App, AppRun, Deployment } from "@keboola/api-client/apps/types";
 import { AdminVendor, App as App$1, AppChange, ServiceAccount, User, Vendor, VendorListItem } from "@keboola/api-client/developerPortal/types";
-import { Table, TableDetail } from "@keboola/api-client/storage/types";
+import { ServiceId } from "@keboola/api-client/constants";
+import { DevBranch, StackInfo, StorageToken, Table, TableDetail } from "@keboola/api-client/storage/types";
 //#region src/clients/apps/apps.d.ts
 declare const appFixtures: {
   neverDeployed: {
@@ -649,19 +650,65 @@ declare const developerPortalFixtures: {
   };
 };
 //#endregion
+//#region src/clients/storage/bootstrap.d.ts
+/** The stack an MSW-backed test points its client at, unless a caller passes its own. */
+declare const DEFAULT_BASE_URL = "https://connection.test";
+type StackInfoOptions = {
+  /** Stack the fixture describes; its host is what the announced service URLs are built on. */
+  baseUrl?: string;
+  /** Services the stack announces. Narrow it to test what a client does without one. */
+  services?: ServiceId[];
+};
+type StorageTokenOptions = {
+  /** Stack the token was issued by — its `uri`. */
+  baseUrl?: string;
+  /** Project features `hasFeature()` should report — the token's `owner.features`. */
+  features?: string[];
+};
+/**
+ * The stack index `GET /v2/storage` returns.
+ *
+ * - Announces every `ServiceId` by default, each on its own host, so no service client is a dummy
+ *   that throws `ServiceUnavailableError` — a test for a queue / data-science / vault hook only
+ *   adds its handler.
+ * - Defaulting to `Object.values(ServiceId)` is what keeps that exhaustive: a service added to the
+ *   client arrives here without an edit.
+ */
+declare const getStackInfo: ({ baseUrl, services }?: StackInfoOptions) => StackInfo;
+/**
+ * The verified master token `GET /v2/storage/tokens/verify` returns.
+ *
+ * - Complete on purpose: `api.context.project.sapiToken` is this object verbatim and hooks read deep
+ *   into it (`owner.id`, `admin.role`, `adminOwner.email`), so a partial body surfaces as
+ *   `undefined`s far from the test that caused them.
+ * - Every permission flag is granted; a test needing a restricted token overrides the handler.
+ */
+declare const verifyStorageToken: ({ baseUrl, features }?: StorageTokenOptions) => StorageToken;
+/**
+ * The branch list `GET /v2/storage/dev-branches` returns — the default branch alone.
+ *
+ * - `context.defaultBranch` is read off it, so the entry must stay `isDefault: true`.
+ * - The default branch has no creator, which `DevBranch` models as an empty `creatorToken`.
+ */
+declare const getDevBranches: () => DevBranch[];
+//#endregion
 //#region src/clients/storage/tables.d.ts
 /**
- * Returns a single realistic typed TableDetail (fresh, no imports yet).
+ * Returns a single non-typed, non-alias `TableDetail` (fresh, no imports yet).
  *
- * The explicit return type ensures any divergence from the OpenAPI-derived
- * `TableDetail` in `@keboola/api-client` surfaces as a TypeScript error.
+ * The explicit return type surfaces any divergence from the hand-written `TableDetail` in
+ * `@keboola/api-client` as a TypeScript error. That type is not derived from the OpenAPI
+ * document, so this annotation and the `satisfies` above are the only mechanical check there is.
  */
 declare const getTable: () => TableDetail;
 /**
  * Returns three TableDetail objects representing different lifecycle states:
- * 1. Fresh — just created, no data imported.
- * 2. Recently updated — moderate size, recent import.
- * 3. Large — high row count, large byte size.
+ * 1. Fresh — just created, nothing loaded (`lastImportDate: null`, `rowsCount: 0`).
+ * 2. Recently updated — 24 500 rows, imported June 2024.
+ * 3. Large — 125 500 rows, imported March 2024.
+ *
+ * The three row counts add up to the shared bucket's own `rowsCount`, and the bucket's
+ * `lastChangeDate` is the newest of theirs, as Storage reports it.
  */
 declare const listTables: () => TableDetail[];
 /**
@@ -702,9 +749,14 @@ declare const tableFixtures: {
       path: string;
       tables: string;
       updated: string;
+      isLinkedBucket: boolean;
+      bucketSharingAllowed: boolean;
     };
     isTyped: false;
     isAlias: false;
+    lastImportDate: null;
+    lastChangeDate: null;
+    rowsCount: number;
   };
   recentlyUpdated: {
     id: string;
@@ -754,9 +806,14 @@ declare const tableFixtures: {
       path: string;
       tables: string;
       updated: string;
+      isLinkedBucket: boolean;
+      bucketSharingAllowed: boolean;
     };
     isTyped: false;
     isAlias: false;
+    lastImportDate: string;
+    lastChangeDate: string;
+    rowsCount: number;
   };
   large: {
     id: string;
@@ -792,15 +849,25 @@ declare const tableFixtures: {
       path: string;
       tables: string;
       updated: string;
+      isLinkedBucket: boolean;
+      bucketSharingAllowed: boolean;
     };
     isTyped: false;
     isAlias: false;
+    lastImportDate: string;
+    lastChangeDate: string;
+    rowsCount: number;
   };
 };
 //#endregion
 //#region src/fixtures.d.ts
 declare const fixtures: {
   storage: {
+    bootstrap: {
+      getStackInfo: typeof getStackInfo;
+      verifyStorageToken: typeof verifyStorageToken;
+      getDevBranches: typeof getDevBranches;
+    };
     tables: {
       getTable: typeof getTable;
       listTables: typeof listTables;
@@ -839,9 +906,14 @@ declare const fixtures: {
             path: string;
             tables: string;
             updated: string;
+            isLinkedBucket: boolean;
+            bucketSharingAllowed: boolean;
           };
           isTyped: false;
           isAlias: false;
+          lastImportDate: null;
+          lastChangeDate: null;
+          rowsCount: number;
         };
         recentlyUpdated: {
           id: string;
@@ -891,9 +963,14 @@ declare const fixtures: {
             path: string;
             tables: string;
             updated: string;
+            isLinkedBucket: boolean;
+            bucketSharingAllowed: boolean;
           };
           isTyped: false;
           isAlias: false;
+          lastImportDate: string;
+          lastChangeDate: string;
+          rowsCount: number;
         };
         large: {
           id: string;
@@ -929,9 +1006,14 @@ declare const fixtures: {
             path: string;
             tables: string;
             updated: string;
+            isLinkedBucket: boolean;
+            bucketSharingAllowed: boolean;
           };
           isTyped: false;
           isAlias: false;
+          lastImportDate: string;
+          lastChangeDate: string;
+          rowsCount: number;
         };
       };
     };
@@ -1564,5 +1646,5 @@ declare const fixtures: {
   };
 };
 //#endregion
-export { type Table, type TableDetail, appFixtures, deploymentFixtures, developerPortalFixtures, fixtures, getApp, getAppRun, getDeployment, getTable, getVendor, listAllApps, listAllVendors, listAppChanges, listAppRuns, listApps, listDeployments, listPublishedApps, listServiceAccounts, listTables, listUsers, listVendorApps, listVendors, runFixtures, tableFixtures };
+export { DEFAULT_BASE_URL, type Table, type TableDetail, appFixtures, deploymentFixtures, developerPortalFixtures, fixtures, getApp, getAppRun, getDeployment, getDevBranches, getStackInfo, getTable, getVendor, listAllApps, listAllVendors, listAppChanges, listAppRuns, listApps, listDeployments, listPublishedApps, listServiceAccounts, listTables, listUsers, listVendorApps, listVendors, runFixtures, tableFixtures, verifyStorageToken };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -1,6 +1,7 @@
+import { ServiceId } from "@keboola/api-client/constants";
 import { App, AppRun, Deployment } from "@keboola/api-client/apps/types";
 import { AdminVendor, App as App$1, AppChange, ServiceAccount, User, Vendor, VendorListItem } from "@keboola/api-client/developerPortal/types";
-import { Table, TableDetail } from "@keboola/api-client/storage/types";
+import { DevBranch, StackInfo, StorageToken, Table, TableDetail } from "@keboola/api-client/storage/types";
 //#region src/clients/apps/apps.d.ts
 declare const appFixtures: {
   neverDeployed: {
@@ -649,19 +650,65 @@ declare const developerPortalFixtures: {
   };
 };
 //#endregion
+//#region src/clients/storage/bootstrap.d.ts
+/** The stack an MSW-backed test points its client at, unless a caller passes its own. */
+declare const DEFAULT_BASE_URL = "https://connection.test";
+type StackInfoOptions = {
+  /** Stack the fixture describes; its host is what the announced service URLs are built on. */
+  baseUrl?: string;
+  /** Services the stack announces. Narrow it to test what a client does without one. */
+  services?: ServiceId[];
+};
+type StorageTokenOptions = {
+  /** Stack the token was issued by — its `uri`. */
+  baseUrl?: string;
+  /** Project features `hasFeature()` should report — the token's `owner.features`. */
+  features?: string[];
+};
+/**
+ * The stack index `GET /v2/storage` returns.
+ *
+ * - Announces every `ServiceId` by default, each on its own host, so no service client is a dummy
+ *   that throws `ServiceUnavailableError` — a test for a queue / data-science / vault hook only
+ *   adds its handler.
+ * - Defaulting to `Object.values(ServiceId)` is what keeps that exhaustive: a service added to the
+ *   client arrives here without an edit.
+ */
+declare const getStackInfo: ({ baseUrl, services }?: StackInfoOptions) => StackInfo;
+/**
+ * The verified master token `GET /v2/storage/tokens/verify` returns.
+ *
+ * - Complete on purpose: `api.context.project.sapiToken` is this object verbatim and hooks read deep
+ *   into it (`owner.id`, `admin.role`, `adminOwner.email`), so a partial body surfaces as
+ *   `undefined`s far from the test that caused them.
+ * - Every permission flag is granted; a test needing a restricted token overrides the handler.
+ */
+declare const verifyStorageToken: ({ baseUrl, features }?: StorageTokenOptions) => StorageToken;
+/**
+ * The branch list `GET /v2/storage/dev-branches` returns — the default branch alone.
+ *
+ * - `context.defaultBranch` is read off it, so the entry must stay `isDefault: true`.
+ * - The default branch has no creator, which `DevBranch` models as an empty `creatorToken`.
+ */
+declare const getDevBranches: () => DevBranch[];
+//#endregion
 //#region src/clients/storage/tables.d.ts
 /**
- * Returns a single realistic typed TableDetail (fresh, no imports yet).
+ * Returns a single non-typed, non-alias `TableDetail` (fresh, no imports yet).
  *
- * The explicit return type ensures any divergence from the OpenAPI-derived
- * `TableDetail` in `@keboola/api-client` surfaces as a TypeScript error.
+ * The explicit return type surfaces any divergence from the hand-written `TableDetail` in
+ * `@keboola/api-client` as a TypeScript error. That type is not derived from the OpenAPI
+ * document, so this annotation and the `satisfies` above are the only mechanical check there is.
  */
 declare const getTable: () => TableDetail;
 /**
  * Returns three TableDetail objects representing different lifecycle states:
- * 1. Fresh — just created, no data imported.
- * 2. Recently updated — moderate size, recent import.
- * 3. Large — high row count, large byte size.
+ * 1. Fresh — just created, nothing loaded (`lastImportDate: null`, `rowsCount: 0`).
+ * 2. Recently updated — 24 500 rows, imported June 2024.
+ * 3. Large — 125 500 rows, imported March 2024.
+ *
+ * The three row counts add up to the shared bucket's own `rowsCount`, and the bucket's
+ * `lastChangeDate` is the newest of theirs, as Storage reports it.
  */
 declare const listTables: () => TableDetail[];
 /**
@@ -702,9 +749,14 @@ declare const tableFixtures: {
       path: string;
       tables: string;
       updated: string;
+      isLinkedBucket: boolean;
+      bucketSharingAllowed: boolean;
     };
     isTyped: false;
     isAlias: false;
+    lastImportDate: null;
+    lastChangeDate: null;
+    rowsCount: number;
   };
   recentlyUpdated: {
     id: string;
@@ -754,9 +806,14 @@ declare const tableFixtures: {
       path: string;
       tables: string;
       updated: string;
+      isLinkedBucket: boolean;
+      bucketSharingAllowed: boolean;
     };
     isTyped: false;
     isAlias: false;
+    lastImportDate: string;
+    lastChangeDate: string;
+    rowsCount: number;
   };
   large: {
     id: string;
@@ -792,15 +849,25 @@ declare const tableFixtures: {
       path: string;
       tables: string;
       updated: string;
+      isLinkedBucket: boolean;
+      bucketSharingAllowed: boolean;
     };
     isTyped: false;
     isAlias: false;
+    lastImportDate: string;
+    lastChangeDate: string;
+    rowsCount: number;
   };
 };
 //#endregion
 //#region src/fixtures.d.ts
 declare const fixtures: {
   storage: {
+    bootstrap: {
+      getStackInfo: typeof getStackInfo;
+      verifyStorageToken: typeof verifyStorageToken;
+      getDevBranches: typeof getDevBranches;
+    };
     tables: {
       getTable: typeof getTable;
       listTables: typeof listTables;
@@ -839,9 +906,14 @@ declare const fixtures: {
             path: string;
             tables: string;
             updated: string;
+            isLinkedBucket: boolean;
+            bucketSharingAllowed: boolean;
           };
           isTyped: false;
           isAlias: false;
+          lastImportDate: null;
+          lastChangeDate: null;
+          rowsCount: number;
         };
         recentlyUpdated: {
           id: string;
@@ -891,9 +963,14 @@ declare const fixtures: {
             path: string;
             tables: string;
             updated: string;
+            isLinkedBucket: boolean;
+            bucketSharingAllowed: boolean;
           };
           isTyped: false;
           isAlias: false;
+          lastImportDate: string;
+          lastChangeDate: string;
+          rowsCount: number;
         };
         large: {
           id: string;
@@ -929,9 +1006,14 @@ declare const fixtures: {
             path: string;
             tables: string;
             updated: string;
+            isLinkedBucket: boolean;
+            bucketSharingAllowed: boolean;
           };
           isTyped: false;
           isAlias: false;
+          lastImportDate: string;
+          lastChangeDate: string;
+          rowsCount: number;
         };
       };
     };
@@ -1564,5 +1646,5 @@ declare const fixtures: {
   };
 };
 //#endregion
-export { type Table, type TableDetail, appFixtures, deploymentFixtures, developerPortalFixtures, fixtures, getApp, getAppRun, getDeployment, getTable, getVendor, listAllApps, listAllVendors, listAppChanges, listAppRuns, listApps, listDeployments, listPublishedApps, listServiceAccounts, listTables, listUsers, listVendorApps, listVendors, runFixtures, tableFixtures };
+export { DEFAULT_BASE_URL, type Table, type TableDetail, appFixtures, deploymentFixtures, developerPortalFixtures, fixtures, getApp, getAppRun, getDeployment, getDevBranches, getStackInfo, getTable, getVendor, listAllApps, listAllVendors, listAppChanges, listAppRuns, listApps, listDeployments, listPublishedApps, listServiceAccounts, listTables, listUsers, listVendorApps, listVendors, runFixtures, tableFixtures, verifyStorageToken };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,3 +1,4 @@
+import { ServiceId } from "@keboola/api-client/constants";
 //#region src/clients/apps/deployments.ts
 /**
 * Deployment ids are the deterministic Kubernetes CR name — `app-{appId}-dpl-{hash}` —
@@ -652,6 +653,125 @@ const developerPortalFixtures = {
 	changes: { single: appChange }
 };
 //#endregion
+//#region src/clients/storage/bootstrap.ts
+/** The stack an MSW-backed test points its client at, unless a caller passes its own. */
+const DEFAULT_BASE_URL = "https://connection.test";
+/**
+* The stack index `GET /v2/storage` returns.
+*
+* - Announces every `ServiceId` by default, each on its own host, so no service client is a dummy
+*   that throws `ServiceUnavailableError` — a test for a queue / data-science / vault hook only
+*   adds its handler.
+* - Defaulting to `Object.values(ServiceId)` is what keeps that exhaustive: a service added to the
+*   client arrives here without an edit.
+*/
+const getStackInfo = ({ baseUrl = DEFAULT_BASE_URL, services = Object.values(ServiceId) } = {}) => {
+	const { host } = new URL(baseUrl);
+	return {
+		api: host,
+		documentation: "https://developers.keboola.com",
+		host,
+		revision: "test-revision",
+		stack: "test-stack",
+		version: "test-version",
+		urlTemplates: { orchestrationJob: "" },
+		services: services.map((id) => ({
+			id,
+			url: `https://${id}.${host}`
+		})),
+		components: [],
+		features: []
+	};
+};
+/**
+* The verified master token `GET /v2/storage/tokens/verify` returns.
+*
+* - Complete on purpose: `api.context.project.sapiToken` is this object verbatim and hooks read deep
+*   into it (`owner.id`, `admin.role`, `adminOwner.email`), so a partial body surfaces as
+*   `undefined`s far from the test that caused them.
+* - Every permission flag is granted; a test needing a restricted token overrides the handler.
+*/
+const verifyStorageToken = ({ baseUrl = DEFAULT_BASE_URL, features = [] } = {}) => ({
+	id: "token-1",
+	created: "2024-01-01T00:00:00Z",
+	refreshed: "2024-01-01T00:00:00Z",
+	description: "Test token",
+	uri: baseUrl,
+	isMasterToken: true,
+	canManageBuckets: true,
+	canManageTokens: true,
+	canReadAllFileUploads: true,
+	canPurgeTrash: true,
+	canManageProtectedDefaultBranch: true,
+	canCreateJobs: true,
+	canReadAllProjectEvents: true,
+	canManageDevBranches: true,
+	creatorToken: {
+		id: 42,
+		description: "Test token"
+	},
+	expires: null,
+	isExpired: false,
+	isDisabled: false,
+	isBYODB: false,
+	dailyCapacity: 1e3,
+	bucketPermissions: {},
+	owner: {
+		id: 42,
+		name: "Test Project",
+		type: "project",
+		region: "us-east-1",
+		created: "2024-01-01T00:00:00Z",
+		expires: null,
+		features,
+		dataSizeBytes: 0,
+		rowsCount: 0,
+		hasMysql: false,
+		hasSynapse: false,
+		hasRedshift: false,
+		hasSnowflake: true,
+		hasExasol: false,
+		hasTeradata: false,
+		hasBigquery: false,
+		defaultBackend: "snowflake",
+		hasTryModeOn: "false",
+		limits: {},
+		metrics: {},
+		isDisabled: false,
+		billedMonthlyPrice: null,
+		dataRetentionTimeInDays: 30,
+		assignedBackends: ["snowflake"],
+		fileStorageProvider: "s3"
+	},
+	organization: { id: "org-1" },
+	admin: {
+		id: 100,
+		name: "Admin User",
+		features: [],
+		isOrganizationMember: true,
+		role: "admin"
+	},
+	adminOwner: {
+		id: 200,
+		name: "Owner User",
+		email: "owner@example.com"
+	}
+});
+/**
+* The branch list `GET /v2/storage/dev-branches` returns — the default branch alone.
+*
+* - `context.defaultBranch` is read off it, so the entry must stay `isDefault: true`.
+* - The default branch has no creator, which `DevBranch` models as an empty `creatorToken`.
+*/
+const getDevBranches = () => [{
+	id: 1,
+	name: "Main",
+	description: "",
+	isDefault: true,
+	created: "2024-01-01T00:00:00Z",
+	creatorToken: []
+}];
+//#endregion
 //#region src/clients/storage/tables.ts
 const bucket = {
 	id: "in.c-main",
@@ -660,7 +780,7 @@ const bucket = {
 	stage: "in",
 	description: "Main input bucket",
 	created: "2024-01-15T10:00:00+0100",
-	lastChangeDate: "2024-03-10T08:30:00+0100",
+	lastChangeDate: "2024-06-01T09:00:00+0200",
 	isMaintenance: false,
 	isReadOnly: false,
 	isSnowflakeSharedDatabase: false,
@@ -677,7 +797,9 @@ const bucket = {
 	sharing: null,
 	path: "in.c-main",
 	tables: "https://connection.keboola.com/v2/storage/buckets/in.c-main/tables",
-	updated: "2024-03-10T08:30:00+0100"
+	updated: "2024-06-01T09:00:00+0200",
+	isLinkedBucket: false,
+	bucketSharingAllowed: true
 };
 const freshTable = {
 	id: "in.c-main.users",
@@ -695,7 +817,10 @@ const freshTable = {
 	attributes: [],
 	bucket,
 	isTyped: false,
-	isAlias: false
+	isAlias: false,
+	lastImportDate: null,
+	lastChangeDate: null,
+	rowsCount: 0
 };
 const recentlyUpdatedTable = {
 	id: "in.c-main.orders",
@@ -727,7 +852,10 @@ const recentlyUpdatedTable = {
 	attributes: [],
 	bucket,
 	isTyped: false,
-	isAlias: false
+	isAlias: false,
+	lastImportDate: "2024-06-01T09:00:00+0200",
+	lastChangeDate: "2024-06-01T09:00:00+0200",
+	rowsCount: 24500
 };
 const largeTable = {
 	id: "in.c-main.events",
@@ -746,20 +874,27 @@ const largeTable = {
 	attributes: [],
 	bucket,
 	isTyped: false,
-	isAlias: false
+	isAlias: false,
+	lastImportDate: "2024-03-10T08:30:00+0100",
+	lastChangeDate: "2024-03-10T08:30:00+0100",
+	rowsCount: 125500
 };
 /**
-* Returns a single realistic typed TableDetail (fresh, no imports yet).
+* Returns a single non-typed, non-alias `TableDetail` (fresh, no imports yet).
 *
-* The explicit return type ensures any divergence from the OpenAPI-derived
-* `TableDetail` in `@keboola/api-client` surfaces as a TypeScript error.
+* The explicit return type surfaces any divergence from the hand-written `TableDetail` in
+* `@keboola/api-client` as a TypeScript error. That type is not derived from the OpenAPI
+* document, so this annotation and the `satisfies` above are the only mechanical check there is.
 */
 const getTable = () => freshTable;
 /**
 * Returns three TableDetail objects representing different lifecycle states:
-* 1. Fresh — just created, no data imported.
-* 2. Recently updated — moderate size, recent import.
-* 3. Large — high row count, large byte size.
+* 1. Fresh — just created, nothing loaded (`lastImportDate: null`, `rowsCount: 0`).
+* 2. Recently updated — 24 500 rows, imported June 2024.
+* 3. Large — 125 500 rows, imported March 2024.
+*
+* The three row counts add up to the shared bucket's own `rowsCount`, and the bucket's
+* `lastChangeDate` is the newest of theirs, as Storage reports it.
 */
 const listTables = () => [
 	freshTable,
@@ -777,11 +912,18 @@ const tableFixtures = {
 //#endregion
 //#region src/fixtures.ts
 const fixtures = {
-	storage: { tables: {
-		getTable,
-		listTables,
-		fixtures: tableFixtures
-	} },
+	storage: {
+		bootstrap: {
+			getStackInfo,
+			verifyStorageToken,
+			getDevBranches
+		},
+		tables: {
+			getTable,
+			listTables,
+			fixtures: tableFixtures
+		}
+	},
 	apps: {
 		apps: {
 			getApp,
@@ -813,6 +955,6 @@ const fixtures = {
 	}
 };
 //#endregion
-export { appFixtures, deploymentFixtures, developerPortalFixtures, fixtures, getApp, getAppRun, getDeployment, getTable, getVendor, listAllApps, listAllVendors, listAppChanges, listAppRuns, listApps, listDeployments, listPublishedApps, listServiceAccounts, listTables, listUsers, listVendorApps, listVendors, runFixtures, tableFixtures };
+export { DEFAULT_BASE_URL, appFixtures, deploymentFixtures, developerPortalFixtures, fixtures, getApp, getAppRun, getDeployment, getDevBranches, getStackInfo, getTable, getVendor, listAllApps, listAllVendors, listAppChanges, listAppRuns, listApps, listDeployments, listPublishedApps, listServiceAccounts, listTables, listUsers, listVendorApps, listVendors, runFixtures, tableFixtures, verifyStorageToken };
 
 //# sourceMappingURL=index.js.map