@gradientedge/commercetools-utils 5.9.1 → 5.10.0

package/dist/typings/models/type.d.ts

@@ -1,177 +0,0 @@
-import { BaseResource, CreatedBy, LastModifiedBy, LocalizedString } from './common';
-export interface CustomFieldEnumValue {
-    readonly key: string;
-    readonly label: string;
-}
-export interface CustomFieldLocalizedEnumValue {
-    readonly key: string;
-    readonly label: LocalizedString;
-}
-export type CustomFieldReferenceValue = 'cart' | 'category' | 'channel' | 'customer' | 'key-value-document' | 'order' | 'product' | 'product-type' | 'review' | 'shipping-method' | 'state' | 'zone' | string;
-export interface CustomFields {
-    readonly type: TypeReference;
-    readonly fields: FieldContainer;
-}
-export interface CustomFieldsDraft {
-    readonly type: TypeResourceIdentifier;
-    readonly fields?: FieldContainer;
-}
-export interface FieldContainer {
-    [key: string]: any;
-}
-export interface FieldDefinition {
-    readonly type: FieldType;
-    readonly name: string;
-    readonly label: LocalizedString;
-    readonly required: boolean;
-    readonly inputHint?: TypeTextInputHint;
-}
-export type FieldType = CustomFieldBooleanType | CustomFieldDateTimeType | CustomFieldDateType | CustomFieldEnumType | CustomFieldLocalizedEnumType | CustomFieldLocalizedStringType | CustomFieldMoneyType | CustomFieldNumberType | CustomFieldReferenceType | CustomFieldSetType | CustomFieldStringType | CustomFieldTimeType;
-export interface CustomFieldBooleanType {
-    readonly name: 'Boolean';
-}
-export interface CustomFieldDateTimeType {
-    readonly name: 'DateTime';
-}
-export interface CustomFieldDateType {
-    readonly name: 'Date';
-}
-export interface CustomFieldEnumType {
-    readonly name: 'Enum';
-    readonly values: CustomFieldEnumValue[];
-}
-export interface CustomFieldLocalizedEnumType {
-    readonly name: 'LocalizedEnum';
-    readonly values: CustomFieldLocalizedEnumValue[];
-}
-export interface CustomFieldLocalizedStringType {
-    readonly name: 'LocalizedString';
-}
-export interface CustomFieldMoneyType {
-    readonly name: 'Money';
-}
-export interface CustomFieldNumberType {
-    readonly name: 'Number';
-}
-export interface CustomFieldReferenceType {
-    readonly name: 'Reference';
-    readonly referenceTypeId: CustomFieldReferenceValue;
-}
-export interface CustomFieldSetType {
-    readonly name: 'Set';
-    readonly elementType: FieldType;
-}
-export interface CustomFieldStringType {
-    readonly name: 'String';
-}
-export interface CustomFieldTimeType {
-    readonly name: 'Time';
-}
-export type ResourceTypeId = 'address' | 'asset' | 'associate-role' | 'business-unit' | 'cart-discount' | 'category' | 'channel' | 'custom-line-item' | 'customer' | 'customer-group' | 'discount-code' | 'inventory-entry' | 'line-item' | 'order' | 'order-delivery' | 'order-edit' | 'order-parcel' | 'order-return-item' | 'payment' | 'payment-interface-interaction' | 'product-price' | 'product-selection' | 'quote' | 'review' | 'shipping' | 'shipping-method' | 'shopping-list' | 'shopping-list-text-line-item' | 'standalone-price' | 'store' | 'transaction' | string;
-export interface Type extends BaseResource {
-    readonly id: string;
-    readonly version: number;
-    readonly createdAt: string;
-    readonly lastModifiedAt: string;
-    readonly lastModifiedBy?: LastModifiedBy;
-    readonly createdBy?: CreatedBy;
-    readonly key: string;
-    readonly name: LocalizedString;
-    readonly description?: LocalizedString;
-    readonly resourceTypeIds: ResourceTypeId[];
-    readonly fieldDefinitions: FieldDefinition[];
-}
-export interface TypeDraft {
-    readonly key: string;
-    readonly name: LocalizedString;
-    readonly description?: LocalizedString;
-    readonly resourceTypeIds: ResourceTypeId[];
-    readonly fieldDefinitions?: FieldDefinition[];
-}
-export interface TypePagedQueryResponse {
-    readonly limit: number;
-    readonly offset: number;
-    readonly count: number;
-    readonly total?: number;
-    readonly results: Type[];
-}
-export interface TypeReference {
-    readonly typeId: 'type';
-    readonly id: string;
-    readonly obj?: Type;
-}
-export interface TypeResourceIdentifier {
-    readonly typeId: 'type';
-    readonly id?: string;
-    readonly key?: string;
-}
-export type TypeTextInputHint = 'MultiLine' | 'SingleLine' | string;
-export interface TypeUpdate {
-    readonly version: number;
-    readonly actions: TypeUpdateAction[];
-}
-export type TypeUpdateAction = TypeAddEnumValueAction | TypeAddFieldDefinitionAction | TypeAddLocalizedEnumValueAction | TypeChangeEnumValueLabelAction | TypeChangeEnumValueOrderAction | TypeChangeFieldDefinitionOrderAction | TypeChangeInputHintAction | TypeChangeKeyAction | TypeChangeLabelAction | TypeChangeLocalizedEnumValueLabelAction | TypeChangeLocalizedEnumValueOrderAction | TypeChangeNameAction | TypeRemoveFieldDefinitionAction | TypeSetDescriptionAction;
-export interface TypeAddEnumValueAction {
-    readonly action: 'addEnumValue';
-    readonly fieldName: string;
-    readonly value: CustomFieldEnumValue;
-}
-export interface TypeAddFieldDefinitionAction {
-    readonly action: 'addFieldDefinition';
-    readonly fieldDefinition: FieldDefinition;
-}
-export interface TypeAddLocalizedEnumValueAction {
-    readonly action: 'addLocalizedEnumValue';
-    readonly fieldName: string;
-    readonly value: CustomFieldLocalizedEnumValue;
-}
-export interface TypeChangeEnumValueLabelAction {
-    readonly action: 'changeEnumValueLabel';
-    readonly fieldName: string;
-    readonly value: CustomFieldEnumValue;
-}
-export interface TypeChangeEnumValueOrderAction {
-    readonly action: 'changeEnumValueOrder';
-    readonly fieldName: string;
-    readonly keys: string[];
-}
-export interface TypeChangeFieldDefinitionOrderAction {
-    readonly action: 'changeFieldDefinitionOrder';
-    readonly fieldNames: string[];
-}
-export interface TypeChangeInputHintAction {
-    readonly action: 'changeInputHint';
-    readonly fieldName: string;
-    readonly inputHint: TypeTextInputHint;
-}
-export interface TypeChangeKeyAction {
-    readonly action: 'changeKey';
-    readonly key: string;
-}
-export interface TypeChangeLabelAction {
-    readonly action: 'changeLabel';
-    readonly fieldName: string;
-    readonly label: LocalizedString;
-}
-export interface TypeChangeLocalizedEnumValueLabelAction {
-    readonly action: 'changeLocalizedEnumValueLabel';
-    readonly fieldName: string;
-    readonly value: CustomFieldLocalizedEnumValue;
-}
-export interface TypeChangeLocalizedEnumValueOrderAction {
-    readonly action: 'changeLocalizedEnumValueOrder';
-    readonly fieldName: string;
-    readonly keys: string[];
-}
-export interface TypeChangeNameAction {
-    readonly action: 'changeName';
-    readonly name: LocalizedString;
-}
-export interface TypeRemoveFieldDefinitionAction {
-    readonly action: 'removeFieldDefinition';
-    readonly fieldName: string;
-}
-export interface TypeSetDescriptionAction {
-    readonly action: 'setDescription';
-    readonly description?: LocalizedString;
-}

package/dist/typings/models/zone.d.ts

@@ -1,65 +0,0 @@
-import { BaseResource, CreatedBy, LastModifiedBy } from './common';
-export interface Location {
-    readonly country: string;
-    readonly state?: string;
-}
-export interface Zone extends BaseResource {
-    readonly id: string;
-    readonly version: number;
-    readonly createdAt: string;
-    readonly lastModifiedAt: string;
-    readonly lastModifiedBy?: LastModifiedBy;
-    readonly createdBy?: CreatedBy;
-    readonly key?: string;
-    readonly name: string;
-    readonly description?: string;
-    readonly locations: Location[];
-}
-export interface ZoneDraft {
-    readonly key?: string;
-    readonly name: string;
-    readonly description?: string;
-    readonly locations?: Location[];
-}
-export interface ZonePagedQueryResponse {
-    readonly limit: number;
-    readonly offset: number;
-    readonly count: number;
-    readonly total?: number;
-    readonly results: Zone[];
-}
-export interface ZoneReference {
-    readonly typeId: 'zone';
-    readonly id: string;
-    readonly obj?: Zone;
-}
-export interface ZoneResourceIdentifier {
-    readonly typeId: 'zone';
-    readonly id?: string;
-    readonly key?: string;
-}
-export interface ZoneUpdate {
-    readonly version: number;
-    readonly actions: ZoneUpdateAction[];
-}
-export type ZoneUpdateAction = ZoneAddLocationAction | ZoneChangeNameAction | ZoneRemoveLocationAction | ZoneSetDescriptionAction | ZoneSetKeyAction;
-export interface ZoneAddLocationAction {
-    readonly action: 'addLocation';
-    readonly location: Location;
-}
-export interface ZoneChangeNameAction {
-    readonly action: 'changeName';
-    readonly name: string;
-}
-export interface ZoneRemoveLocationAction {
-    readonly action: 'removeLocation';
-    readonly location: Location;
-}
-export interface ZoneSetDescriptionAction {
-    readonly action: 'setDescription';
-    readonly description?: string;
-}
-export interface ZoneSetKeyAction {
-    readonly action: 'setKey';
-    readonly key?: string;
-}

package/dist/typings/request/index.d.ts

@@ -1,2 +0,0 @@
-export * from './request';
-export * from './is-retryable-error';

package/dist/typings/request/is-retryable-error.d.ts

@@ -1 +0,0 @@
-export declare function isRetryableError(error: any): boolean;

package/dist/typings/request/transform-error.d.ts

@@ -1,2 +0,0 @@
-import { CommercetoolsError } from '../error';
-export declare function transformError(lastError: any): Error | CommercetoolsError;

package/dist/typings/utils/axios/index.d.ts

@@ -1,4 +0,0 @@
-export * from './convert-error';
-export * from './convert-response';
-export * from './create-instance';
-export * from './extract-headers';

package/dist/typings/utils/calculate-delay.d.ts

@@ -1,2 +0,0 @@
-import { CommercetoolsRetryConfig } from '../api';
-export declare function calculateDelay(retryCount: number, retryConfig?: Omit<CommercetoolsRetryConfig, 'maxRetries'>): number;

package/dist/typings/utils/ensure-non-empty-string.d.ts

@@ -1,5 +0,0 @@
-export interface EnsureNonEmptyStringParams {
-    value: string;
-    name: string;
-}
-export declare function ensureNonEmptyString(options: EnsureNonEmptyStringParams): void;

package/dist/typings/utils/format.d.ts

@@ -1 +0,0 @@
-export declare function formatAsKey(input: unknown): string;

package/dist/typings/utils/get-attribute-value.d.ts

@@ -1,6 +0,0 @@
-import { Attribute } from '../models';
-export interface GetAttributeValueParams {
-    attributes: Attribute[] | null | undefined;
-    name: string;
-}
-export declare function getAttributeValue<T = any>(options: GetAttributeValueParams): T | null;

package/dist/typings/utils/index.d.ts

@@ -1,8 +0,0 @@
-export * from './axios';
-export * from './calculate-delay';
-export * from './ensure-non-empty-string';
-export * from './format';
-export * from './get-attribute-value';
-export * from './mask';
-export * from './retry-on-conflict';
-export * from './useragent';

package/dist/typings/utils/mask.d.ts

@@ -1,6 +0,0 @@
-export declare const SENSITIVE_PROPERTY_NAMES: string[];
-export declare const SENSITIVE_HEADER_NAMES: string[];
-export declare const DEFAULT_MASKING_STRING = "********";
-export declare function maskSensitiveInput(data: unknown): any;
-export declare function maskSensitiveHeaders(data: unknown): any;
-export declare function maskSensitiveData(data: any, propertyNames: string[], mask?: string): any;

package/dist/typings/utils/plain-clone.d.ts

@@ -1 +0,0 @@
-export declare function plainClone(source: any): any;

package/dist/typings/utils/retry-on-conflict.d.ts

@@ -1,7 +0,0 @@
-export interface RetryOnConflictParams<T = any> {
-    executeFn: (attemptNo: number) => Promise<T>;
-    delayMs?: number;
-    maxRetries?: number;
-    jitter?: boolean;
-}
-export declare function retryOnConflict<T = any>(options: RetryOnConflictParams): Promise<T>;

package/dist/typings/utils/useragent.d.ts

@@ -1 +0,0 @@
-export declare function buildUserAgent(systemIdentifier?: string): string;