@remkoj/optimizely-graph-client 2.0.4 → 3.0.0

package/README.md

@@ -1,135 +1,195 @@
-# Optimizely Graph Client <!-- omit in toc -->
-An extension of the [graphql-request](https://www.npmjs.com/package/graphql-request) package, providing the configuration and additional logic needed to connect with Optimizely Graph.
-
-## Within this document <!-- omit in toc -->
-- [1. Provided services](#1-provided-services)
-- [2. Usage example](#2-usage-example)
-  - [2.1. GraphQL Client](#21-graphql-client)
-  - [2.2. Admin API](#22-admin-api)
-- [3. Configuration](#3-configuration)
-  - [3.1. Advanced Features](#31-advanced-features)
-
-## 1. Provided services
-The package contains the following services:
-- The configuration logic, to read and validate the configuration. Supports both runtime configuration objects as well a reading from environment variables.
-- The GraphQL Client, based upon [graphql-request](https://www.npmjs.com/package/graphql-request), supporting the following authentication schemes for Optimizely Graph:
-  - Public access (e.g. using the Single key)
-  - HMAC Signed messages
-  - Basic Authentication
-  - Token pass-through (for Optimizely CMS in context editing)
-- A RouteResolver, which simplifies handling routes when using Optimizely CMS, using the Optimizely Graph as datasource.
-- A ChannelRepository, which simplifies reading channel (website) configuration from the Optimizely CMS, using the Optimizely Graph as datasource.
-- An OpenAPI Client for the administrative REST services of Optimizely Graph. This follows the [service specification](https://cg.optimizely.com/app/swagger/swagger.json) and is based upon the code generated by [openapi-typescript-codegen](https://www.npmjs.com/package/openapi-typescript-codegen) from this service specification.
-
-## 2. Usage example
-### 2.1. GraphQL Client
-```typescript
-// Import the library
-import { gql } from 'graphql-request'
-import createClient, { AuthMode } from '@remkoj/optimizely-graph-client/client'
-import Router from '@remkoj/optimizely-graph-client/router'
-import ChannelRepository from '@remkoj/optimizely-graph-client/channels'
-
-// Prepare the query
-const document = gql`query {
-  Content {
-    items {
-      Name
-      ContentLink {
-        GuidValue
-      }
-      Language {
-        Name
-      }
-    }
-  }
-}`
-
-// Create an instance of the client, the configuration object may be omitted 
-// when executing on Node.JS. If no configuration is provided, it will be read
-// from the environment variables.
-// The variable client will be of type: GraphQLClient
-const client = createClient({
-  single_key: "your_single_key"
-})
-
-// By default the client will always use AuthMode.Public, unless overridden by the
-// second parameter of createClient. Use the updateAuthentication to change the
-// authentication mode after creation
-client.updateAuthentication(AuthMode.Public)
-
-// Execute a GraphQL query, the second paramer can be used to send in variables
-const result = await client.request(document)
-
-// Use the Router to get all routes registered by Optimizely CMS
-const router = new Router(client)
-const allPaths = await router.getRoutes()
-
-// Use the ChannelRepository to get all registered channels within Optimizely CMS
-const channels = new ChannelRepository(client)
-const allChannels = await channels.getAll()
-```
-
-### 2.2. Admin API
-***Warning***: The AdminAPI of Optimizely Graph requires your App Key & Secret as it allows full management of the service. When used in a browser, take all needed steps to prevent leaking of these credentials.
-
-```typescript
-import createAdminApi from '@remkoj/optimizely-graph-client/admin'
-
-// Create an instance of the client, the configuration object may be omitted 
-// when executing on Node.JS. If no configuration is provided, it will be read
-// from the environment variables.
-const api = createAdminApi({
-    single_key: "your single key",
-    app_key: "your app key",
-    secret: "your secret"
-})
-
-// Use the webhooks endpoint to list all registered webhooks
-const hooks = await api.webhooks.listWebhookHandler()
-```
-
-## 3. Configuration
-The following configuration options are available, the table lists both the environment variable as well as property within the configuration object.
-
-| Environment | Configuration object | Required | Usage |
-| --- | --- | --- | --- |
-| `OPTIMIZELY_GRAPH_GATEWAY` | gateway | no | The endpoint for Optimizely Graph |
-| `OPTIMIZELY_GRAPH_SINGLE_KEY` | single_key | yes | The key needed for public, read-only access |
-| `OPTIMIZELY_GRAPH_SECRET` | secret | no | The Optimizely Graph secret for write access, this value must never be made available in a browser |
-| `OPTIMIZELY_GRAPH_APP_KEY` | app_key | no | The Optimizely Graph app_key for write access, this value must never be made available in a browser |
-| `SITE_DOMAIN` | deploy_domain | no | The domain of the frontend |
-| `OPTIMIZELY_CMS_URL` | dxp_url | yes | The domain where the CMS has been installed |
-| `OPTIMIZELY_GRAPH_QUERY_LOG` | query_log | no | Set to "true" to enable query output to the console |
-| `OPTIMIZELY_DEBUG` | debug | no | Set to "true" to enable verbose debug output to the console |
-
-### 3.1. Advanced Features
-The Optimizely Graph Client has support for a number of the feature flags in Optimizely Graph and can enable/disable those on the fly.
-
-The following features can currently be toggled:
-- **Caching *[Default: enabled]*:** Provides control over the service output cache, setting this to false will make all requests be evaluated in real time instead of being cached.
-- **Stored queries *[Default: enabled]*:** This will store the query to the underlying data store, so even when the output cache is invalidated, this will prevent the query to the data store to be regenerated. **Warning**: This feature does not work with cursors, so either disable it temporary or completely if you need cursors in you queries.
-- **Recursive queries *[Default: disabled]*:** When enabled it enables the execution of the `@recursive(depth: n)` directive. If compatible with the queries used, this can significantly reduce the number of queries needed to build a page.
-
-The flags are controlled by the following instance methods & fields on the Client object:
-- `updateFlags(newFlags, temporary)`: Update the flags for the instance. If there's roll-back information it will throw an Error. When temporary is enabled it will create a roll-back copy of the current flags prior to updating.
-- `restoreFlags()`: Restore the flags to the stored 'roll-back' copy, if there's no roll-back copy, no action is taken and no Error will be thrown.
-
-#### Example <!-- omit in toc -->
-For server-side code, with access to environment variables, adjust according to your case.
-```typescript
-// Import client & create instance
-import createClient from '@remkoj/optimizely-graph-client/client';
-const client = createClient();
-
-// Set the default for this client to add support for recursive queries
-client.updateFlags({ recursive: true });
-
-// Temporary disable the query cache to allow queries with cursor
-client.updateFlags({ queryCache: false }, true);
-
-...
-
-// Roll-back to preferred flag settings
-client.restoreFlags();
-```
+# Optimizely Graph Client <!-- omit in toc -->
+An extension of the [graphql-request](https://www.npmjs.com/package/graphql-request) package, providing the configuration and additional logic needed to connect with Optimizely Graph.
+
+## Within this document <!-- omit in toc -->
+- [1. Provided services](#1-provided-services)
+- [2. Usage example](#2-usage-example)
+  - [2.1. GraphQL Client](#21-graphql-client)
+  - [2.2. GraphQL Client Authentication](#22-graphql-client-authentication)
+    - [2.2.1. Graph Keys](#221-graph-keys)
+    - [2.2.2. Token passthrough](#222-token-passthrough)
+    - [2.2.3. OpenID Connect](#223-openid-connect)
+    - [2.2.4. Token passthrough](#224-token-passthrough)
+  - [2.3. Admin API](#23-admin-api)
+- [3. Configuration](#3-configuration)
+  - [3.1. Advanced Features](#31-advanced-features)
+
+## 1. Provided services
+The package contains the following services:
+- The configuration logic, to read and validate the configuration. Supports both runtime configuration objects as well a reading from environment variables.
+- The GraphQL Client, based upon [graphql-request](https://www.npmjs.com/package/graphql-request), supporting the following authentication schemes for Optimizely Graph:
+  - Public access (e.g. using the Single key)
+  - HMAC Signed messages
+  - Basic Authentication
+  - Token pass-through (for Optimizely CMS in context editing)
+- A RouteResolver, which simplifies handling routes when using Optimizely CMS, using the Optimizely Graph as datasource.
+- A ChannelRepository, which simplifies reading channel (website) configuration from the Optimizely CMS, using the Optimizely Graph as datasource.
+- An OpenAPI Client for the administrative REST services of Optimizely Graph. This follows the [service specification](https://cg.optimizely.com/app/swagger/swagger.json) and is based upon the code generated by [openapi-typescript-codegen](https://www.npmjs.com/package/openapi-typescript-codegen) from this service specification.
+
+## 2. Usage example
+### 2.1. GraphQL Client
+```typescript
+// Import the library
+import { gql } from 'graphql-request'
+import createClient, { AuthMode } from '@remkoj/optimizely-graph-client/client'
+import Router from '@remkoj/optimizely-graph-client/router'
+import ChannelRepository from '@remkoj/optimizely-graph-client/channels'
+
+// Prepare the query
+const document = gql`query {
+  Content {
+    items {
+      Name
+      ContentLink {
+        GuidValue
+      }
+      Language {
+        Name
+      }
+    }
+  }
+}`
+
+// Create an instance of the client, the configuration object may be omitted 
+// when executing on Node.JS. If no configuration is provided, it will be read
+// from the environment variables.
+// The variable client will be of type: GraphQLClient
+const client = createClient({
+  single_key: "your_single_key"
+})
+
+// By default the client will always use AuthMode.Public, unless overridden by the
+// second parameter of createClient. Use the updateAuthentication to change the
+// authentication mode after creation
+client.updateAuthentication(AuthMode.Public)
+
+// Execute a GraphQL query, the second paramer can be used to send in variables
+const result = await client.request(document)
+
+// Use the Router to get all routes registered by Optimizely CMS
+const router = new Router(client)
+const allPaths = await router.getRoutes()
+
+// Use the ChannelRepository to get all registered channels within Optimizely CMS
+const channels = new ChannelRepository(client)
+const allChannels = await channels.getAll()
+```
+
+### 2.2. GraphQL Client Authentication 
+Optimizely Graph allows restricted content to be queried, using either of the following patterns:
+
+* **Graph Keys**: Admin authentication using Graph Sercet Key and App Key
+* **Token passthrough**: Used by CMS preview/edit mode to provide a short lived access token to query the content to be previewed/edited. [Read more](https://docs.developers.optimizely.com/platform-optimizely/v1.4.0-optimizely-graph/docs/on-page-editing-using-content-graph)
+* **OpenID Connect**: Used by the frontend to pass through OpenID Connect based JWT to authorize content. [Read more](https://docs.developers.optimizely.com/platform-optimizely/v1.4.0-optimizely-graph/docs/opti-id)
+* **Generic Login**: Used by the fronend to pass through the username/roles from a trusted identity provider. [Read more](https://docs.developers.optimizely.com/platform-optimizely/v1.4.0-optimizely-graph/docs/basic-auth-from-backend)
+
+#### 2.2.1. Graph Keys
+The Graph Keys authentication mechanism can be enabled by providing the App Secret and App Key as part of the configuration. Then depending on your security policy, use either:
+
+- Basic Authentication: `client.updateAuthentication(AuthMode.Basic)`
+- HMAC Authentication: `client.updateAuthentication(AuthMode.HMAC)`
+
+HMAC provides slightly better security as it both ensures message integrity and never transmits the App Secret in a decryptable form.
+
+#### 2.2.2. Token passthrough
+This method of authentication is specific to Optimizely CMS, where the edit UI will provide a short-lived token that allows access to the content that is being edited. This only requires the Single Key to be known.
+
+```typescript
+const tokenValue: string = ''; //Your token value here
+client.updateAuthentication(tokenValue)
+```
+
+#### 2.2.3. OpenID Connect
+This method requires two steps, first, the client must be configured with the Turnstile Tenant ID, secondly the JWT Token of the OIDC provider must be added to the client.
+
+```typescript
+const client = createClient({
+  single_key: "your_single_key",
+  tenant_id: "your_turnstile_tenant_id"
+})
+const tokenValue: string = ''; //Your OIDC JWT Token
+client.updateAuthentication(tokenValue)
+```
+
+#### 2.2.4. Token passthrough
+This method works with non-OIDC compliant identity providers, but requires a trusted connection with Optimizely Graph. As such, it requires the Graph Keys to ensure that the client is authorized to pass in the username and roles directly.
+
+The roles must be provided as a comma separated list, without spaces around the values. Both the username and roles must exactly match the roles and usernames defined in Optimizely CMS.
+
+```typescript
+const client = createClient({
+  single_key: "your_single_key",
+  app_key: "your_app_key",
+  secret: "your_secret"
+})
+client.setFrontendUser({
+  username: "your_username",
+  roles: "list_of_roles"
+})
+```
+
+### 2.3. Admin API
+***Warning***: The AdminAPI of Optimizely Graph requires your App Key & Secret as it allows full management of the service. When used in a browser, take all needed steps to prevent leaking of these credentials.
+
+```typescript
+import createAdminApi from '@remkoj/optimizely-graph-client/admin'
+
+// Create an instance of the client, the configuration object may be omitted 
+// when executing on Node.JS. If no configuration is provided, it will be read
+// from the environment variables.
+const api = createAdminApi({
+    single_key: "your single key",
+    app_key: "your app key",
+    secret: "your secret"
+})
+
+// Use the webhooks endpoint to list all registered webhooks
+const hooks = await api.webhooks.listWebhookHandler()
+```
+
+## 3. Configuration
+The following configuration options are available, the table lists both the environment variable as well as property within the configuration object.
+
+| Environment | Configuration object | Required | Usage |
+| --- | --- | --- | --- |
+| `OPTIMIZELY_GRAPH_GATEWAY` | gateway | no | The endpoint for Optimizely Graph |
+| `OPTIMIZELY_GRAPH_SINGLE_KEY` | single_key | yes | The key needed for public, read-only access |
+| `OPTIMIZELY_GRAPH_SECRET` | secret | no | The Optimizely Graph secret for write access, this value must never be made available in a browser |
+| `OPTIMIZELY_GRAPH_APP_KEY` | app_key | no | The Optimizely Graph app_key for write access, this value must never be made available in a browser |
+| `OPTIMIZELY_GRAPH_TENANT_ID` | tenant_id | no | The Optimizely Graph Tenant ID.<br/><br/>*Only required when using OIDC Authentication* |
+| `SITE_DOMAIN` | deploy_domain | no | The domain of the frontend |
+| `OPTIMIZELY_CMS_URL` | dxp_url | yes | The domain where the CMS has been installed |
+| `OPTIMIZELY_CMS_SCHEMA` | opti_cms_schema | no | The marker for the CMS schema version, which can be used by services and the implementation. Valid values are: `OPTI-CMS-12` and `OPTI-CMS-13`. The default value is `OPTI-CMS-13` |
+| `OPTIMIZELY_GRAPH_QUERY_LOG` | query_log | no | Set to "true" to enable query output to the console |
+| `OPTIMIZELY_DEBUG` | debug | no | Set to "true" to enable verbose debug output to the console |
+
+### 3.1. Advanced Features
+The Optimizely Graph Client has support for a number of the feature flags in Optimizely Graph and can enable/disable those on the fly.
+
+The following features can currently be toggled:
+- **Caching *[Default: enabled]*:** Provides control over the service output cache, setting this to false will make all requests be evaluated in real time instead of being cached.
+- **Stored queries *[Default: enabled]*:** This will store the query to the underlying data store, so even when the output cache is invalidated, this will prevent the query to the data store to be regenerated. **Warning**: This feature does not work with cursors, so either disable it temporary or completely if you need cursors in you queries.
+- **Recursive queries *[Default: disabled]*:** When enabled it enables the execution of the `@recursive(depth: n)` directive. If compatible with the queries used, this can significantly reduce the number of queries needed to build a page.
+
+The flags are controlled by the following instance methods & fields on the Client object:
+- `updateFlags(newFlags, temporary)`: Update the flags for the instance. If there's roll-back information it will throw an Error. When temporary is enabled it will create a roll-back copy of the current flags prior to updating.
+- `restoreFlags()`: Restore the flags to the stored 'roll-back' copy, if there's no roll-back copy, no action is taken and no Error will be thrown.
+
+#### Example <!-- omit in toc -->
+For server-side code, with access to environment variables, adjust according to your case.
+```typescript
+// Import client & create instance
+import createClient from '@remkoj/optimizely-graph-client/client';
+const client = createClient();
+
+// Set the default for this client to add support for recursive queries
+client.updateFlags({ recursive: true });
+
+// Temporary disable the query cache to allow queries with cursor
+client.updateFlags({ queryCache: false }, true);
+
+...
+
+// Roll-back to preferred flag settings
+client.restoreFlags();
+```

package/dist/admin-api/client/OptimizelyGraphAdminApi.js

@@ -11,7 +11,7 @@ export class OptimizelyGraphAdminApi {
     constructor(config, HttpRequest = FetchHttpRequest) {
         this.request = new HttpRequest({
             BASE: config?.BASE ?? 'https://prod.cg.optimizely.com',
-            VERSION: config?.VERSION ?? '3.10.0',
+            VERSION: config?.VERSION ?? '3.13.0',
             WITH_CREDENTIALS: config?.WITH_CREDENTIALS ?? false,
             CREDENTIALS: config?.CREDENTIALS ?? 'include',
             TOKEN: config?.TOKEN,

package/dist/admin-api/client/core/OpenAPI.js

@@ -1,6 +1,6 @@
 export const OpenAPI = {
     BASE: 'https://prod.cg.optimizely.com',
-    VERSION: '3.10.0',
+    VERSION: '3.13.0',
     WITH_CREDENTIALS: false,
     CREDENTIALS: 'include',
     TOKEN: undefined,

package/dist/admin-api/client/index.d.ts

@@ -7,10 +7,10 @@ export type { OpenAPIConfig } from './core/OpenAPI.js';
 export type { BestBetCollectionPayload } from './models/BestBetCollectionPayload.js';
 export type { BestBetCollectionResult } from './models/BestBetCollectionResult.js';
 export type { CacheInvalidationConfig } from './models/CacheInvalidationConfig.js';
+export type { ContentSource_V2 } from './models/ContentSource_V2.js';
+export type { ContentSource_V3 } from './models/ContentSource_V3.js';
 export type { ContentType_V2 } from './models/ContentType_V2.js';
 export type { ContentType_V3 } from './models/ContentType_V3.js';
-export type { ContentTypeDefinition_V2 } from './models/ContentTypeDefinition_V2.js';
-export type { ContentTypeDefinition_V3 } from './models/ContentTypeDefinition_V3.js';
 export type { ContentTypeMap_V3 } from './models/ContentTypeMap_V3.js';
 export type { ContentTypeProperty_V2 } from './models/ContentTypeProperty_V2.js';
 export type { ContentTypeProperty_V3 } from './models/ContentTypeProperty_V3.js';
@@ -22,7 +22,7 @@ export type { LinkMap } from './models/LinkMap.js';
 export type { LinkProperty } from './models/LinkProperty.js';
 export type { OperationMap } from './models/OperationMap.js';
 export type { Optional_string_ } from './models/Optional_string_.js';
-export type { Partial_Record_FieldKeys_OperationMap__ } from './models/Partial_Record_FieldKeys_OperationMap__.js';
+export type { Partial_Record_string_OperationMap__ } from './models/Partial_Record_string_OperationMap__.js';
 export { Preset } from './models/Preset.js';
 export type { Property_V2 } from './models/Property_V2.js';
 export type { Property_V3 } from './models/Property_V3.js';
@@ -35,6 +35,7 @@ export type { Request } from './models/Request.js';
 export type { RequestLog } from './models/RequestLog.js';
 export type { SourceInfo } from './models/SourceInfo.js';
 export type { SourceInfoMap } from './models/SourceInfoMap.js';
+export type { SourceMetadata } from './models/SourceMetadata.js';
 export type { StopwordsBody } from './models/StopwordsBody.js';
 export type { SynonymsBody } from './models/SynonymsBody.js';
 export type { TokenClaims } from './models/TokenClaims.js';

package/dist/admin-api/client/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/admin-api/client/index.ts"],"names":[],"mappings":"AAAA,+DAA+D;AAC/D,0BAA0B;AAC1B,oBAAoB;AACpB,oBAAoB;AACpB,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAEvE,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC7E,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAa5C,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AASpD,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAkB5C,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/admin-api/client/index.ts"],"names":[],"mappings":"AAAA,+DAA+D;AAC/D,0BAA0B;AAC1B,oBAAoB;AACpB,oBAAoB;AACpB,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAEvE,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC7E,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAa5C,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AASpD,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAmB5C,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC"}

package/dist/admin-api/client/models/{ContentTypeDefinition_V2.d.ts → ContentSource_V2.d.ts}

@@ -1,7 +1,7 @@
 import type { ContentType_V2 } from './ContentType_V2.js';
 import type { LinkMap } from './LinkMap.js';
 import type { PropertyType_V2 } from './PropertyType_V2.js';
-export type ContentTypeDefinition_V2 = {
+export type ContentSource_V2 = {
     useTypedFieldNames?: boolean;
     languages?: Array<string>;
     links?: LinkMap;

package/dist/admin-api/client/models/ContentSource_V2.js

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

package/dist/admin-api/client/models/ContentSource_V2.js.map

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

package/dist/admin-api/client/models/{ContentTypeDefinition_V3.d.ts → ContentSource_V3.d.ts}

@@ -3,12 +3,13 @@ import type { LinkMap } from './LinkMap.js';
 import type { Optional_string_ } from './Optional_string_.js';
 import type { Preset } from './Preset.js';
 import type { PropertyTypeMap_V3 } from './PropertyTypeMap_V3.js';
-export type ContentTypeDefinition_V3 = {
+export type ContentSource_V3 = {
     languages?: Array<string>;
     contentTypes?: ContentTypeMap_V3;
     propertyTypes?: PropertyTypeMap_V3;
     links?: LinkMap;
     label?: Optional_string_;
+    description?: Optional_string_;
     useTypedFieldNames?: boolean;
     preset?: Preset;
 };

package/dist/admin-api/client/models/ContentSource_V3.js

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

package/dist/admin-api/client/models/ContentSource_V3.js.map

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

package/dist/admin-api/client/models/FilterMap.d.ts

@@ -1,2 +1,2 @@
-import type { Partial_Record_FieldKeys_OperationMap__ } from './Partial_Record_FieldKeys_OperationMap__.js';
-export type FilterMap = Partial_Record_FieldKeys_OperationMap__;
+import type { Partial_Record_string_OperationMap__ } from './Partial_Record_string_OperationMap__.js';
+export type FilterMap = Partial_Record_string_OperationMap__;

package/dist/admin-api/client/models/OperationMap.d.ts

@@ -1,4 +1,4 @@
 export type OperationMap = {
-    in?: Array<string>;
+    in?: (string | Array<string>);
     eq?: string;
 };

package/dist/admin-api/client/models/Partial_Record_string_OperationMap__.d.ts

@@ -0,0 +1,5 @@
+import type { OperationMap } from './OperationMap.js';
+/**
+ * Make all properties in T optional
+ */
+export type Partial_Record_string_OperationMap__ = Record<string, OperationMap>;

package/dist/admin-api/client/models/Partial_Record_string_OperationMap__.js

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

package/dist/admin-api/client/models/Partial_Record_string_OperationMap__.js.map

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

package/dist/admin-api/client/models/SourceInfo.d.ts

@@ -1,5 +1,6 @@
 export type SourceInfo = {
     languages: Array<string>;
+    description: string;
     label: string;
     id: string;
 };

package/dist/admin-api/client/models/SourceMetadata.d.ts

@@ -0,0 +1,4 @@
+export type SourceMetadata = {
+    label: string;
+    description: string;
+};

package/dist/admin-api/client/models/SourceMetadata.js

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

package/dist/admin-api/client/models/SourceMetadata.js.map

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

package/dist/admin-api/client/models/Webhook.d.ts

@@ -1,4 +1,6 @@
+import type { Preset } from './Preset.js';
 import type { WebhookPayload } from './WebhookPayload.js';
 export type Webhook = (WebhookPayload & {
+    preset: Preset;
     id: string;
 });

package/dist/admin-api/client/models/WebhookPayload.d.ts

@@ -1,4 +1,4 @@
-import type { Partial_Record_FieldKeys_OperationMap__ } from './Partial_Record_FieldKeys_OperationMap__.js';
+import type { Partial_Record_string_OperationMap__ } from './Partial_Record_string_OperationMap__.js';
 import type { Request } from './Request.js';
 /**
  * The `WebhookPayload` type represents the payload of a webhook request, which includes information
@@ -8,5 +8,5 @@ export type WebhookPayload = {
     disabled?: boolean;
     request: Request;
     topics?: Array<string>;
-    filters?: (Array<Partial_Record_FieldKeys_OperationMap__> | Partial_Record_FieldKeys_OperationMap__);
+    filters?: (Array<Partial_Record_string_OperationMap__> | Partial_Record_string_OperationMap__);
 };

package/dist/admin-api/client/services/DefinitionV2Service.d.ts

@@ -1,4 +1,4 @@
-import type { ContentTypeDefinition_V2 } from '../models/ContentTypeDefinition_V2.js';
+import type { ContentSource_V2 } from '../models/ContentSource_V2.js';
 import type { CancelablePromise } from '../core/CancelablePromise.js';
 import type { BaseHttpRequest } from '../core/BaseHttpRequest.js';
 export declare class DefinitionV2Service {
@@ -30,5 +30,5 @@ export declare class DefinitionV2Service {
      * @returns any Successfully updated content type
      * @throws ApiError
      */
-    postContentV2TypeHandler(requestBody: ContentTypeDefinition_V2): CancelablePromise<any>;
+    postContentV2TypeHandler(requestBody: ContentSource_V2): CancelablePromise<any>;
 }

package/dist/admin-api/client/services/DefinitionV2Service.js.map

@@ -1 +1 @@
-{"version":3,"file":"DefinitionV2Service.js","sourceRoot":"","sources":["../../../../src/admin-api/client/services/DefinitionV2Service.ts"],"names":[],"mappings":"AAOA,MAAM,OAAO,mBAAmB;IAC5B,YAA4B,WAA4B;QAA5B,gBAAW,GAAX,WAAW,CAAiB;IAAG,CAAC;IAC5D;;;;;;;OAOG;IACI,wBAAwB,CAC3B,EAAU,EACV,WAAmB;QAEnB,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,sBAAsB;YAC3B,KAAK,EAAE;gBACH,IAAI,EAAE,EAAE;aACX;YACD,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;SAChC,CAAC,CAAC;IACP,CAAC;IACD;;;;;;;OAOG;IACI,0BAA0B,CAC7B,EAAU,EACV,SAAyB;QAEzB,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,QAAQ;YAChB,GAAG,EAAE,sBAAsB;YAC3B,KAAK,EAAE;gBACH,IAAI,EAAE,EAAE;gBACR,WAAW,EAAE,SAAS;aACzB;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;;OAOG;IACI,wBAAwB,CAC3B,WAAqC;QAErC,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,uBAAuB;YAC5B,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;YAC7B,MAAM,EAAE;gBACJ,GAAG,EAAE,6CAA6C;aACrD;SACJ,CAAC,CAAC;IACP,CAAC;CACJ"}
+{"version":3,"file":"DefinitionV2Service.js","sourceRoot":"","sources":["../../../../src/admin-api/client/services/DefinitionV2Service.ts"],"names":[],"mappings":"AAOA,MAAM,OAAO,mBAAmB;IAC5B,YAA4B,WAA4B;QAA5B,gBAAW,GAAX,WAAW,CAAiB;IAAG,CAAC;IAC5D;;;;;;;OAOG;IACI,wBAAwB,CAC3B,EAAU,EACV,WAAmB;QAEnB,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,sBAAsB;YAC3B,KAAK,EAAE;gBACH,IAAI,EAAE,EAAE;aACX;YACD,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;SAChC,CAAC,CAAC;IACP,CAAC;IACD;;;;;;;OAOG;IACI,0BAA0B,CAC7B,EAAU,EACV,SAAyB;QAEzB,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,QAAQ;YAChB,GAAG,EAAE,sBAAsB;YAC3B,KAAK,EAAE;gBACH,IAAI,EAAE,EAAE;gBACR,WAAW,EAAE,SAAS;aACzB;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;;OAOG;IACI,wBAAwB,CAC3B,WAA6B;QAE7B,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,uBAAuB;YAC5B,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;YAC7B,MAAM,EAAE;gBACJ,GAAG,EAAE,6CAA6C;aACrD;SACJ,CAAC,CAAC;IACP,CAAC;CACJ"}

package/dist/admin-api/client/services/DefinitionV3Service.d.ts

@@ -1,6 +1,7 @@
-import type { ContentTypeDefinition_V3 } from '../models/ContentTypeDefinition_V3.js';
+import type { ContentSource_V3 } from '../models/ContentSource_V3.js';
 import type { DeleteMode } from '../models/DeleteMode.js';
 import type { SourceInfoMap } from '../models/SourceInfoMap.js';
+import type { SourceMetadata } from '../models/SourceMetadata.js';
 import type { CancelablePromise } from '../core/CancelablePromise.js';
 import type { BaseHttpRequest } from '../core/BaseHttpRequest.js';
 export declare class DefinitionV3Service {
@@ -8,7 +9,7 @@ export declare class DefinitionV3Service {
     constructor(httpRequest: BaseHttpRequest);
     /**
      * Get source metadata
-     * Get `id`, `label` and `languages` fields of the source
+     * Get `id`, `label`, `description` and `languages` fields of the source
      * @param id The id of the source _(optional)_
      * - _(empty): all sources_
      * - _**default**: only default source_
@@ -36,14 +37,23 @@ export declare class DefinitionV3Service {
      * @throws ApiError
      */
     deleteContentV3SourceHandler(id?: string, mode?: DeleteMode): CancelablePromise<any>;
+    /**
+     * Update source metadata
+     * Update `label`, `description` fields of the source
+     * @param id The id of the source
+     * @param requestBody The new metadata source
+     * @returns void
+     * @throws ApiError
+     */
+    postContentV3SourceHandler(id: string, requestBody: SourceMetadata): CancelablePromise<void>;
     /**
      * Get content types
      * Get content types of the source
      * @param id The id of the source
-     * @returns ContentTypeDefinition_V3 Ok
+     * @returns ContentSource_V3 Ok
      * @throws ApiError
      */
-    getContentV3TypeHandler(id?: string): CancelablePromise<ContentTypeDefinition_V3>;
+    getContentV3TypeHandler(id?: string): CancelablePromise<ContentSource_V3>;
     /**
      * Partial content type update
      * Update content types of the source partially
@@ -52,7 +62,7 @@ export declare class DefinitionV3Service {
      * @returns void
      * @throws ApiError
      */
-    postContentV3TypeHandler(requestBody: ContentTypeDefinition_V3, id?: string): CancelablePromise<void>;
+    postContentV3TypeHandler(requestBody: ContentSource_V3, id?: string): CancelablePromise<void>;
     /**
      * Full content type update
      * Update content types of the source (overwrite all)
@@ -61,5 +71,5 @@ export declare class DefinitionV3Service {
      * @returns void
      * @throws ApiError
      */
-    putContentV3TypeHandler(requestBody: ContentTypeDefinition_V3, id?: string): CancelablePromise<void>;
+    putContentV3TypeHandler(requestBody: ContentSource_V3, id?: string): CancelablePromise<void>;
 }