@vendure/admin-ui 3.6.0-minor-202511061550 → 3.6.0-minor-202512162012

package/{core → package/core}/common/generated-types.d.ts

@@ -42,22 +42,18 @@ export type Scalars = {
         input: number;
         output: number;
     };
-    /** A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the `date-time` format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar. */
     DateTime: {
         input: any;
         output: any;
     };
-    /** The `JSON` scalar type represents JSON values as specified by [ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf). */
     JSON: {
         input: any;
         output: any;
     };
-    /** The `Money` scalar type represents monetary values and supports signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point). */
     Money: {
         input: number;
         output: number;
     };
-    /** The `Upload` scalar type represents a file upload. */
     Upload: {
         input: any;
         output: any;
@@ -196,6 +192,74 @@ export type AlreadyRefundedError = ErrorResult & {
     message: Scalars['String']['output'];
     refundId: Scalars['ID']['output'];
 };
+export type ApiKey = Node & {
+    __typename?: 'ApiKey';
+    createdAt: Scalars['DateTime']['output'];
+    customFields?: Maybe<Scalars['JSON']['output']>;
+    id: Scalars['ID']['output'];
+    /** Helps you identify unused keys */
+    lastUsedAt?: Maybe<Scalars['DateTime']['output']>;
+    /**
+     * ID by which we can look up the API-Key.
+     * Also helps you identify keys without leaking the underlying secret API-Key.
+     */
+    lookupId: Scalars['String']['output'];
+    /** A descriptive name so you can remind yourself where the API-Key gets used */
+    name: Scalars['String']['output'];
+    /**
+     * Usually the user who created the ApiKey but could also be used as the basis for
+     * restricting resolvers to `Permission.Owner` queries for customers for example.
+     */
+    owner: User;
+    translations: Array<ApiKeyTranslation>;
+    updatedAt: Scalars['DateTime']['output'];
+    /** This is the underlying User which determines the kind of permissions for this API-Key. */
+    user: User;
+};
+export type ApiKeyFilterParameter = {
+    _and?: InputMaybe<Array<ApiKeyFilterParameter>>;
+    _or?: InputMaybe<Array<ApiKeyFilterParameter>>;
+    createdAt?: InputMaybe<DateOperators>;
+    id?: InputMaybe<IdOperators>;
+    lastUsedAt?: InputMaybe<DateOperators>;
+    lookupId?: InputMaybe<StringOperators>;
+    name?: InputMaybe<StringOperators>;
+    updatedAt?: InputMaybe<DateOperators>;
+};
+export type ApiKeyList = PaginatedList & {
+    __typename?: 'ApiKeyList';
+    items: Array<ApiKey>;
+    totalItems: Scalars['Int']['output'];
+};
+export type ApiKeyListOptions = {
+    /** Allows the results to be filtered */
+    filter?: InputMaybe<ApiKeyFilterParameter>;
+    /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
+    filterOperator?: InputMaybe<LogicalOperator>;
+    /** Skips the first n results, for use in pagination */
+    skip?: InputMaybe<Scalars['Int']['input']>;
+    /** Specifies which properties to sort the results by */
+    sort?: InputMaybe<ApiKeySortParameter>;
+    /** Takes n results, for use in pagination */
+    take?: InputMaybe<Scalars['Int']['input']>;
+};
+export type ApiKeySortParameter = {
+    createdAt?: InputMaybe<SortOrder>;
+    id?: InputMaybe<SortOrder>;
+    lastUsedAt?: InputMaybe<SortOrder>;
+    lookupId?: InputMaybe<SortOrder>;
+    name?: InputMaybe<SortOrder>;
+    updatedAt?: InputMaybe<SortOrder>;
+};
+export type ApiKeyTranslation = Node & {
+    __typename?: 'ApiKeyTranslation';
+    createdAt: Scalars['DateTime']['output'];
+    id: Scalars['ID']['output'];
+    languageCode: LanguageCode;
+    /** A descriptive name so you can remind yourself where the API-Key gets used */
+    name: Scalars['String']['output'];
+    updatedAt: Scalars['DateTime']['output'];
+};
 export type ApplyCouponCodeResult = CouponCodeExpiredError | CouponCodeInvalidError | CouponCodeLimitError | Order;
 export type Asset = Node & {
     __typename?: 'Asset';
@@ -713,6 +777,32 @@ export type CreateAdministratorInput = {
     password: Scalars['String']['input'];
     roleIds: Array<Scalars['ID']['input']>;
 };
+/**
+ * There is no User ID because you can only create API-Keys for yourself,
+ * which gets determined by the User who does the request.
+ */
+export type CreateApiKeyInput = {
+    customFields?: InputMaybe<Scalars['JSON']['input']>;
+    /**
+     * Which roles to attach to this ApiKey.
+     * You may only grant roles which you, yourself have.
+     */
+    roleIds: Array<Scalars['ID']['input']>;
+    translations: Array<CreateApiKeyTranslationInput>;
+};
+export type CreateApiKeyResult = {
+    __typename?: 'CreateApiKeyResult';
+    /** The generated API-Key. API-Keys cannot be viewed again after creation! */
+    apiKey: Scalars['String']['output'];
+    /** ID of the created ApiKey-Entity */
+    entityId: Scalars['ID']['output'];
+};
+export type CreateApiKeyTranslationInput = {
+    customFields?: InputMaybe<Scalars['JSON']['input']>;
+    languageCode: LanguageCode;
+    /** A descriptive name so you can remind yourself where the API-Key gets used */
+    name: Scalars['String']['input'];
+};
 export type CreateAssetInput = {
     customFields?: InputMaybe<Scalars['JSON']['input']>;
     file: Scalars['Upload']['input'];
@@ -1287,6 +1377,7 @@ export type CustomFields = {
     __typename?: 'CustomFields';
     Address: Array<CustomFieldConfig>;
     Administrator: Array<CustomFieldConfig>;
+    ApiKey: Array<CustomFieldConfig>;
     Asset: Array<CustomFieldConfig>;
     Channel: Array<CustomFieldConfig>;
     Collection: Array<CustomFieldConfig>;
@@ -2616,6 +2707,12 @@ export type Mutation = {
     cancelPayment: CancelPaymentResult;
     /** Create a new Administrator */
     createAdministrator: Administrator;
+    /**
+     * Generates a new API-Key and attaches it to an Administrator.
+     * Returns the generated API-Key.
+     * API-Keys cannot be viewed again after creation.
+     */
+    createApiKey: CreateApiKeyResult;
     /** Create a new Asset */
     createAssets: Array<CreateAssetResult>;
     /** Create a new Channel */
@@ -2670,6 +2767,8 @@ export type Mutation = {
     deleteAdministrator: DeletionResponse;
     /** Delete multiple Administrators */
     deleteAdministrators: Array<DeletionResponse>;
+    /** Deletes API-Keys */
+    deleteApiKeys: Array<DeletionResponse>;
     /** Delete an Asset */
     deleteAsset: DeletionResponse;
     /** Delete multiple Assets */
@@ -2811,6 +2910,12 @@ export type Mutation = {
     removeStockLocationsFromChannel: Array<StockLocation>;
     requestCompleted: Scalars['Int']['output'];
     requestStarted: Scalars['Int']['output'];
+    /**
+     * Replaces the old with a new API-Key.
+     * This is a convenience method to invalidate an API-Key without
+     * deleting the underlying roles and permissions.
+     */
+    rotateApiKey: RotateApiKeyResult;
     runPendingSearchIndexUpdates: Success;
     runScheduledTask: Success;
     setActiveChannel: UserStatus;
@@ -2851,6 +2956,8 @@ export type Mutation = {
     updateActiveAdministrator: Administrator;
     /** Update an existing Administrator */
     updateAdministrator: Administrator;
+    /** Updates an API-Key */
+    updateApiKey: ApiKey;
     /** Update an existing Asset */
     updateAsset: Asset;
     /** Update an existing Channel */
@@ -2992,6 +3099,9 @@ export type MutationCancelPaymentArgs = {
 export type MutationCreateAdministratorArgs = {
     input: CreateAdministratorInput;
 };
+export type MutationCreateApiKeyArgs = {
+    input: CreateApiKeyInput;
+};
 export type MutationCreateAssetsArgs = {
     input: Array<CreateAssetInput>;
 };
@@ -3075,6 +3185,9 @@ export type MutationDeleteAdministratorArgs = {
 export type MutationDeleteAdministratorsArgs = {
     ids: Array<Scalars['ID']['input']>;
 };
+export type MutationDeleteApiKeysArgs = {
+    ids: Array<Scalars['ID']['input']>;
+};
 export type MutationDeleteAssetArgs = {
     input: DeleteAssetInput;
 };
@@ -3284,6 +3397,9 @@ export type MutationRemoveShippingMethodsFromChannelArgs = {
 export type MutationRemoveStockLocationsFromChannelArgs = {
     input: RemoveStockLocationsFromChannelInput;
 };
+export type MutationRotateApiKeyArgs = {
+    id: Scalars['ID']['input'];
+};
 export type MutationRunScheduledTaskArgs = {
     id: Scalars['String']['input'];
 };
@@ -3374,6 +3490,9 @@ export type MutationUpdateActiveAdministratorArgs = {
 export type MutationUpdateAdministratorArgs = {
     input: UpdateAdministratorInput;
 };
+export type MutationUpdateApiKeyArgs = {
+    input: UpdateApiKeyInput;
+};
 export type MutationUpdateAssetArgs = {
     input: UpdateAssetInput;
 };
@@ -3975,6 +4094,8 @@ export declare enum Permission {
     Authenticated = "Authenticated",
     /** Grants permission to create Administrator */
     CreateAdministrator = "CreateAdministrator",
+    /** Grants permission to create ApiKey */
+    CreateApiKey = "CreateApiKey",
     /** Grants permission to create Asset */
     CreateAsset = "CreateAsset",
     /** Grants permission to create Products, Facets, Assets, Collections */
@@ -4019,6 +4140,8 @@ export declare enum Permission {
     CreateZone = "CreateZone",
     /** Grants permission to delete Administrator */
     DeleteAdministrator = "DeleteAdministrator",
+    /** Grants permission to delete ApiKey */
+    DeleteApiKey = "DeleteApiKey",
     /** Grants permission to delete Asset */
     DeleteAsset = "DeleteAsset",
     /** Grants permission to delete Products, Facets, Assets, Collections */
@@ -4068,6 +4191,8 @@ export declare enum Permission {
     Public = "Public",
     /** Grants permission to read Administrator */
     ReadAdministrator = "ReadAdministrator",
+    /** Grants permission to read ApiKey */
+    ReadApiKey = "ReadApiKey",
     /** Grants permission to read Asset */
     ReadAsset = "ReadAsset",
     /** Grants permission to read Products, Facets, Assets, Collections */
@@ -4114,6 +4239,8 @@ export declare enum Permission {
     SuperAdmin = "SuperAdmin",
     /** Grants permission to update Administrator */
     UpdateAdministrator = "UpdateAdministrator",
+    /** Grants permission to update ApiKey */
+    UpdateApiKey = "UpdateApiKey",
     /** Grants permission to update Asset */
     UpdateAsset = "UpdateAsset",
     /** Grants permission to update Products, Facets, Assets, Collections */
@@ -4616,6 +4743,8 @@ export type Query = {
     activeChannel: Channel;
     administrator?: Maybe<Administrator>;
     administrators: AdministratorList;
+    apiKey?: Maybe<ApiKey>;
+    apiKeys: ApiKeyList;
     /** Get a single Asset by id */
     asset?: Maybe<Asset>;
     /** Get a list of Assets */
@@ -4715,6 +4844,12 @@ export type QueryAdministratorArgs = {
 export type QueryAdministratorsArgs = {
     options?: InputMaybe<AdministratorListOptions>;
 };
+export type QueryApiKeyArgs = {
+    id: Scalars['ID']['input'];
+};
+export type QueryApiKeysArgs = {
+    options?: InputMaybe<ApiKeyListOptions>;
+};
 export type QueryAssetArgs = {
     id: Scalars['ID']['input'];
 };
@@ -5114,6 +5249,11 @@ export type RoleSortParameter = {
     id?: InputMaybe<SortOrder>;
     updatedAt?: InputMaybe<SortOrder>;
 };
+export type RotateApiKeyResult = {
+    __typename?: 'RotateApiKeyResult';
+    /** The generated API-Key. API-Keys cannot be viewed again after creation! */
+    apiKey: Scalars['String']['output'];
+};
 export type Sale = Node & StockMovement & {
     __typename?: 'Sale';
     createdAt: Scalars['DateTime']['output'];
@@ -5814,6 +5954,24 @@ export type UpdateAdministratorInput = {
     password?: InputMaybe<Scalars['String']['input']>;
     roleIds?: InputMaybe<Array<Scalars['ID']['input']>>;
 };
+export type UpdateApiKeyInput = {
+    customFields?: InputMaybe<Scalars['JSON']['input']>;
+    /** ID of the ApiKey */
+    id: Scalars['ID']['input'];
+    /**
+     * Which roles to attach to this ApiKey.
+     * You may only grant roles which you, yourself have.
+     */
+    roleIds?: InputMaybe<Array<Scalars['ID']['input']>>;
+    translations?: InputMaybe<Array<UpdateApiKeyTranslationInput>>;
+};
+export type UpdateApiKeyTranslationInput = {
+    customFields?: InputMaybe<Scalars['JSON']['input']>;
+    id?: InputMaybe<Scalars['ID']['input']>;
+    languageCode: LanguageCode;
+    /** A descriptive name so you can remind yourself where the API-Key gets used */
+    name?: InputMaybe<Scalars['String']['input']>;
+};
 export type UpdateAssetInput = {
     customFields?: InputMaybe<Scalars['JSON']['input']>;
     focalPoint?: InputMaybe<CoordinateInput>;

package/package/core/common/version.d.ts

@@ -0,0 +1 @@
+export declare const ADMIN_UI_VERSION = "3.6.0-minor-202512162012";

package/{fesm2022 → package/fesm2022}/vendure-admin-ui-core.mjs

@@ -1165,6 +1165,8 @@ var Permission;
     Permission["Authenticated"] = "Authenticated";
     /** Grants permission to create Administrator */
     Permission["CreateAdministrator"] = "CreateAdministrator";
+    /** Grants permission to create ApiKey */
+    Permission["CreateApiKey"] = "CreateApiKey";
     /** Grants permission to create Asset */
     Permission["CreateAsset"] = "CreateAsset";
     /** Grants permission to create Products, Facets, Assets, Collections */
@@ -1209,6 +1211,8 @@ var Permission;
     Permission["CreateZone"] = "CreateZone";
     /** Grants permission to delete Administrator */
     Permission["DeleteAdministrator"] = "DeleteAdministrator";
+    /** Grants permission to delete ApiKey */
+    Permission["DeleteApiKey"] = "DeleteApiKey";
     /** Grants permission to delete Asset */
     Permission["DeleteAsset"] = "DeleteAsset";
     /** Grants permission to delete Products, Facets, Assets, Collections */
@@ -1258,6 +1262,8 @@ var Permission;
     Permission["Public"] = "Public";
     /** Grants permission to read Administrator */
     Permission["ReadAdministrator"] = "ReadAdministrator";
+    /** Grants permission to read ApiKey */
+    Permission["ReadApiKey"] = "ReadApiKey";
     /** Grants permission to read Asset */
     Permission["ReadAsset"] = "ReadAsset";
     /** Grants permission to read Products, Facets, Assets, Collections */
@@ -1304,6 +1310,8 @@ var Permission;
     Permission["SuperAdmin"] = "SuperAdmin";
     /** Grants permission to update Administrator */
     Permission["UpdateAdministrator"] = "UpdateAdministrator";
+    /** Grants permission to update ApiKey */
+    Permission["UpdateApiKey"] = "UpdateApiKey";
     /** Grants permission to update Asset */
     Permission["UpdateAsset"] = "UpdateAsset";
     /** Grants permission to update Products, Facets, Assets, Collections */
@@ -7856,7 +7864,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.15", ngImpo
         }], ctorParameters: () => [{ type: AlertsService }] });
 
 // Auto-generated by the set-version.js script.
-const ADMIN_UI_VERSION = '3.6.0-minor-202511061550';
+const ADMIN_UI_VERSION = '3.6.0-minor-202512162012';
 
 /* eslint-disable @angular-eslint/directive-selector */
 class FormFieldControlDirective {
@@ -9965,6 +9973,8 @@ const result = {
             'Address',
             'Administrator',
             'Allocation',
+            'ApiKey',
+            'ApiKeyTranslation',
             'Asset',
             'AuthenticationMethod',
             'Cancellation',
@@ -10008,6 +10018,7 @@ const result = {
         ],
         PaginatedList: [
             'AdministratorList',
+            'ApiKeyList',
             'AssetList',
             'ChannelList',
             'CollectionList',