@commercelayer/provisioning-sdk 2.0.0-beta.1 → 2.0.0-beta.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/lib/index.d.mts +32 -1
  2. package/lib/index.d.ts +32 -1
  3. package/package.json +1 -1
package/lib/index.d.mts CHANGED
@@ -154,9 +154,11 @@ declare class ListResponse<R> extends Array<R> {
154
154
  }
155
155
 
156
156
  type ResourceSort = Pick<Resource, 'id' | 'reference' | 'reference_origin' | 'created_at' | 'updated_at'>;
157
+ type ResourceFilter = Pick<Resource, 'id' | 'reference' | 'reference_origin' | 'metadata' | 'created_at' | 'updated_at'>;
157
158
  type ResourceAdapterConfig = {};
158
159
  type ResourcesInitConfig = ResourceAdapterConfig & ApiClientInitConfig;
159
160
  type ResourcesConfig = Partial<ResourcesInitConfig>;
161
+ declare const apiResourceAdapter: (config: ResourcesInitConfig) => ResourceAdapter;
160
162
  declare class ResourceAdapter {
161
163
  #private;
162
164
  constructor(config: ResourcesInitConfig);
@@ -570,6 +572,35 @@ declare class Users extends ApiSingleton<User> {
570
572
  }
571
573
 
572
574
  type ResourceTypeLock = 'api_credentials' | 'application_memberships' | 'memberships' | 'organizations' | 'permissions' | 'roles' | 'user' | 'versions';
575
+ declare const resourceList: readonly ["api_credentials", "application_memberships", "memberships", "organizations", "permissions", "roles", "user", "versions"];
576
+ declare const singletonList: readonly ["user"];
577
+ type RetrievableResourceType = ResourceTypeLock;
578
+ type RetrievableResource = Resource & {
579
+ type: RetrievableResourceType;
580
+ };
581
+ type ListableResourceType = Exclude<ResourceTypeLock, 'user'>;
582
+ type ListableResource = Resource & {
583
+ type: ListableResourceType;
584
+ };
585
+ type CreatableResourceType = 'api_credentials' | 'application_memberships' | 'memberships' | 'organizations' | 'permissions' | 'roles';
586
+ type CreatableResource = Resource & {
587
+ type: CreatableResourceType;
588
+ };
589
+ type UpdatableResourceType = 'api_credentials' | 'application_memberships' | 'memberships' | 'organizations' | 'permissions' | 'roles';
590
+ type UpdatableResource = Resource & {
591
+ type: UpdatableResourceType;
592
+ };
593
+ type DeletableResourceType = 'api_credentials' | 'application_memberships' | 'memberships';
594
+ type DeletableResource = Resource & {
595
+ type: DeletableResourceType;
596
+ };
597
+ type VersionableResourceType = 'memberships' | 'permissions' | 'roles';
598
+ type VersionableResource = Resource & {
599
+ type: VersionableResourceType;
600
+ versions?: Array<ResourceRel & {
601
+ type: VersionType;
602
+ }> | null;
603
+ };
573
604
  type ResourceFields = {
574
605
  api_credentials: ApiCredential;
575
606
  application_memberships: ApplicationMembership;
@@ -662,4 +693,4 @@ declare const CommerceLayerProvisioningStatic: {
662
693
  readonly schemaVersion: string;
663
694
  };
664
695
 
665
- export { type ApiCredential, type ApiCredentialCreate, type ApiCredentialSort, type ApiCredentialUpdate, ApiError, type ApplicationMembership, type ApplicationMembershipCreate, type ApplicationMembershipSort, type ApplicationMembershipUpdate, CommerceLayerProvisioning, CommerceLayerProvisioningClient, CommerceLayerProvisioningStatic, type ErrorObj, ErrorType, type HeadersObj, type Membership, type MembershipCreate, type MembershipSort, type MembershipUpdate, type Organization, type OrganizationCreate, type OrganizationSort, type OrganizationUpdate, type Permission, type PermissionCreate, type PermissionSort, type PermissionUpdate, type QueryParams, type QueryParamsList, type QueryParamsRetrieve, type RequestObj, type ResponseObj, type Role, type RoleCreate, type RoleSort, type RoleUpdate, SdkError, type User, type UserSort, type UserUpdate, type Version, type VersionSort, CommerceLayerProvisioning as default };
696
+ export { type ApiCredential, type ApiCredentialCreate, type ApiCredentialSort, type ApiCredentialUpdate, ApiCredentials, ApiError, ApiResource, ApiSingleton, type ApplicationMembership, type ApplicationMembershipCreate, type ApplicationMembershipSort, type ApplicationMembershipUpdate, ApplicationMemberships, CommerceLayerProvisioning, CommerceLayerProvisioningClient, CommerceLayerProvisioningStatic, type CreatableResource, type CreatableResourceType, type DeletableResource, type DeletableResourceType, type ErrorObj, ErrorType, type HeadersObj, type ListMeta, ListResponse, type ListableResource, type ListableResourceType, type Membership, type MembershipCreate, type MembershipSort, type MembershipUpdate, Memberships, type Metadata, type Organization, type OrganizationCreate, type OrganizationSort, type OrganizationUpdate, Organizations, type Permission, type PermissionCreate, type PermissionSort, type PermissionUpdate, Permissions, type QueryParams, type QueryParamsList, type QueryParamsRetrieve, type RequestObj, type Resource, type ResourceCreate, type ResourceFields, type ResourceFilter, type ResourceId, type ResourceRel, type ResourceSort, type ResourceSortFields, type ResourceType, type ResourceTypeLock, type ResourceUpdate, type ResourcesConfig, type ResourcesInitConfig, type ResponseObj, type RetrievableResource, type RetrievableResourceType, type Role, type RoleCreate, type RoleSort, type RoleUpdate, Roles, SdkError, type UpdatableResource, type UpdatableResourceType, type User, type UserSort, type UserUpdate, Users, type Version, type VersionSort, type VersionableResource, type VersionableResourceType, Versions, apiResourceAdapter, CommerceLayerProvisioning as default, resourceList, singletonList };
package/lib/index.d.ts CHANGED
@@ -154,9 +154,11 @@ declare class ListResponse<R> extends Array<R> {
154
154
  }
155
155
 
156
156
  type ResourceSort = Pick<Resource, 'id' | 'reference' | 'reference_origin' | 'created_at' | 'updated_at'>;
157
+ type ResourceFilter = Pick<Resource, 'id' | 'reference' | 'reference_origin' | 'metadata' | 'created_at' | 'updated_at'>;
157
158
  type ResourceAdapterConfig = {};
158
159
  type ResourcesInitConfig = ResourceAdapterConfig & ApiClientInitConfig;
159
160
  type ResourcesConfig = Partial<ResourcesInitConfig>;
161
+ declare const apiResourceAdapter: (config: ResourcesInitConfig) => ResourceAdapter;
160
162
  declare class ResourceAdapter {
161
163
  #private;
162
164
  constructor(config: ResourcesInitConfig);
@@ -570,6 +572,35 @@ declare class Users extends ApiSingleton<User> {
570
572
  }
571
573
 
572
574
  type ResourceTypeLock = 'api_credentials' | 'application_memberships' | 'memberships' | 'organizations' | 'permissions' | 'roles' | 'user' | 'versions';
575
+ declare const resourceList: readonly ["api_credentials", "application_memberships", "memberships", "organizations", "permissions", "roles", "user", "versions"];
576
+ declare const singletonList: readonly ["user"];
577
+ type RetrievableResourceType = ResourceTypeLock;
578
+ type RetrievableResource = Resource & {
579
+ type: RetrievableResourceType;
580
+ };
581
+ type ListableResourceType = Exclude<ResourceTypeLock, 'user'>;
582
+ type ListableResource = Resource & {
583
+ type: ListableResourceType;
584
+ };
585
+ type CreatableResourceType = 'api_credentials' | 'application_memberships' | 'memberships' | 'organizations' | 'permissions' | 'roles';
586
+ type CreatableResource = Resource & {
587
+ type: CreatableResourceType;
588
+ };
589
+ type UpdatableResourceType = 'api_credentials' | 'application_memberships' | 'memberships' | 'organizations' | 'permissions' | 'roles';
590
+ type UpdatableResource = Resource & {
591
+ type: UpdatableResourceType;
592
+ };
593
+ type DeletableResourceType = 'api_credentials' | 'application_memberships' | 'memberships';
594
+ type DeletableResource = Resource & {
595
+ type: DeletableResourceType;
596
+ };
597
+ type VersionableResourceType = 'memberships' | 'permissions' | 'roles';
598
+ type VersionableResource = Resource & {
599
+ type: VersionableResourceType;
600
+ versions?: Array<ResourceRel & {
601
+ type: VersionType;
602
+ }> | null;
603
+ };
573
604
  type ResourceFields = {
574
605
  api_credentials: ApiCredential;
575
606
  application_memberships: ApplicationMembership;
@@ -662,4 +693,4 @@ declare const CommerceLayerProvisioningStatic: {
662
693
  readonly schemaVersion: string;
663
694
  };
664
695
 
665
- export { type ApiCredential, type ApiCredentialCreate, type ApiCredentialSort, type ApiCredentialUpdate, ApiError, type ApplicationMembership, type ApplicationMembershipCreate, type ApplicationMembershipSort, type ApplicationMembershipUpdate, CommerceLayerProvisioning, CommerceLayerProvisioningClient, CommerceLayerProvisioningStatic, type ErrorObj, ErrorType, type HeadersObj, type Membership, type MembershipCreate, type MembershipSort, type MembershipUpdate, type Organization, type OrganizationCreate, type OrganizationSort, type OrganizationUpdate, type Permission, type PermissionCreate, type PermissionSort, type PermissionUpdate, type QueryParams, type QueryParamsList, type QueryParamsRetrieve, type RequestObj, type ResponseObj, type Role, type RoleCreate, type RoleSort, type RoleUpdate, SdkError, type User, type UserSort, type UserUpdate, type Version, type VersionSort, CommerceLayerProvisioning as default };
696
+ export { type ApiCredential, type ApiCredentialCreate, type ApiCredentialSort, type ApiCredentialUpdate, ApiCredentials, ApiError, ApiResource, ApiSingleton, type ApplicationMembership, type ApplicationMembershipCreate, type ApplicationMembershipSort, type ApplicationMembershipUpdate, ApplicationMemberships, CommerceLayerProvisioning, CommerceLayerProvisioningClient, CommerceLayerProvisioningStatic, type CreatableResource, type CreatableResourceType, type DeletableResource, type DeletableResourceType, type ErrorObj, ErrorType, type HeadersObj, type ListMeta, ListResponse, type ListableResource, type ListableResourceType, type Membership, type MembershipCreate, type MembershipSort, type MembershipUpdate, Memberships, type Metadata, type Organization, type OrganizationCreate, type OrganizationSort, type OrganizationUpdate, Organizations, type Permission, type PermissionCreate, type PermissionSort, type PermissionUpdate, Permissions, type QueryParams, type QueryParamsList, type QueryParamsRetrieve, type RequestObj, type Resource, type ResourceCreate, type ResourceFields, type ResourceFilter, type ResourceId, type ResourceRel, type ResourceSort, type ResourceSortFields, type ResourceType, type ResourceTypeLock, type ResourceUpdate, type ResourcesConfig, type ResourcesInitConfig, type ResponseObj, type RetrievableResource, type RetrievableResourceType, type Role, type RoleCreate, type RoleSort, type RoleUpdate, Roles, SdkError, type UpdatableResource, type UpdatableResourceType, type User, type UserSort, type UserUpdate, Users, type Version, type VersionSort, type VersionableResource, type VersionableResourceType, Versions, apiResourceAdapter, CommerceLayerProvisioning as default, resourceList, singletonList };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@commercelayer/provisioning-sdk",
3
- "version": "2.0.0-beta.1",
3
+ "version": "2.0.0-beta.3",
4
4
  "main": "lib/index.js",
5
5
  "types": "lib/index.d.ts",
6
6
  "module": "lib/index.mjs",