@arianee/common-types - npm Package Compare versions

Comparing version 0.4.0 to 0.5.0

package.json

 {
   "name": "@arianee/common-types",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "type": "commonjs",
@@ -5,0 +5,0 @@ "peerDependencies": {

src/index.d.ts

@@ -1,10 +0,10 @@
-export { ArianeeBrandIdentityI18N } from './lib/arianeeBrandIdentity-i18n';
-export { ArianeeEventI18N } from './lib/arianeeEvent-i18n';
-export { ArianeeMessageI18N } from './lib/arianeeMessage-i18n';
-export { ArianeeProductCertificateI18N } from './lib/arianeeProductCertificate-i18n';
-export { BlockchainEvent } from './lib/blockchainEvent';
-export { Protocol } from './lib/protocol';
-export { SmartAsset } from './lib/smartAsset';
-export { Event } from './lib/event';
-export { BrandIdentity } from './lib/brandIdentity';
-export { DecentralizedMessage } from './lib/decentralizedMessage';
+export * from './lib/arianeeBrandIdentity-i18n';
+export * from './lib/arianeeEvent-i18n';
+export * from './lib/arianeeMessage-i18n';
+export * from './lib/arianeeProductCertificate-i18n';
+export * from './lib/blockchainEvent';
+export * from './lib/protocol';
+export * from './lib/smartAsset';
+export * from './lib/event';
+export * from './lib/brandIdentity';
+export * from './lib/decentralizedMessage';

src/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./lib/arianeeBrandIdentity-i18n"), exports);
+tslib_1.__exportStar(require("./lib/arianeeEvent-i18n"), exports);
+tslib_1.__exportStar(require("./lib/arianeeMessage-i18n"), exports);
+tslib_1.__exportStar(require("./lib/arianeeProductCertificate-i18n"), exports);
+tslib_1.__exportStar(require("./lib/blockchainEvent"), exports);
+tslib_1.__exportStar(require("./lib/protocol"), exports);
+tslib_1.__exportStar(require("./lib/smartAsset"), exports);
+tslib_1.__exportStar(require("./lib/event"), exports);
+tslib_1.__exportStar(require("./lib/brandIdentity"), exports);
+tslib_1.__exportStar(require("./lib/decentralizedMessage"), exports);
 //# sourceMappingURL=index.js.map

src/lib/arianeeEvent-i18n.d.ts

 export interface ArianeeEventI18N {
     $schema: string;
     eventType?: EventType;
-    language?: LanguageCode;
+    language?: EventLanguageCode;
     title?: string;
     description?: string;
-    externalContents?: ExternalContent[];
-    i18n?: i18nContent[];
-    medias?: Media[];
-    attributes?: Attribute[];
+    externalContents?: EventExternalContent[];
+    i18n?: EventI18nContent[];
+    medias?: EventMedia[];
+    attributes?: EventAttribute[];
     valuePrice?: string;
-    currencyPrice?: Currency;
+    currencyPrice?: EventCurrency;
     location?: string;
 }
-export type LanguageCode = 'fr-FR' | 'en-US' | 'zh-TW' | 'zh-CN' | 'ko-KR' | 'ja-JP' | 'de-DE' | 'es' | 'it';
+export type EventLanguageCode = 'fr-FR' | 'en-US' | 'zh-TW' | 'zh-CN' | 'ko-KR' | 'ja-JP' | 'de-DE' | 'es' | 'it';
 export type EventType = 'service' | 'auction' | 'initialSale' | 'warranty' | 'resell' | 'repair' | 'experience';
-export type ExternalContentType = 'website' | 'eshop' | 'other';
-export type MediaType = 'picture' | 'youtube';
-export type MediaTypeType = 'product';
-export type AttributeType = 'color' | 'material' | 'printed';
-export type Currency = 'USD' | 'EUR' | 'GBP';
-export interface ExternalContent {
-    type: ExternalContentType;
+export type EventExternalContentType = 'website' | 'eshop' | 'other';
+export type EventMediaMediaType = 'picture' | 'youtube';
+export type EventMediaType = 'product';
+export type EventAttributeType = 'color' | 'material' | 'printed';
+export type EventCurrency = 'USD' | 'EUR' | 'GBP';
+export interface EventExternalContent {
+    type: EventExternalContentType;
     title: string;
@@ -28,5 +28,5 @@ url: string;
 }
-export interface Media {
-    mediaType: MediaType;
-    type: MediaTypeType;
+export interface EventMedia {
+    mediaType: EventMediaMediaType;
+    type: EventMediaType;
     url: string;
@@ -36,11 +36,11 @@ hash?: string;
 }
-export interface Attribute {
-    type: AttributeType;
+export interface EventAttribute {
+    type: EventAttributeType;
     value: string;
 }
-export interface i18nContent {
-    language: LanguageCode;
+export interface EventI18nContent {
+    language: EventLanguageCode;
     title?: string;
     description?: string;
-    externalContents?: ExternalContent[];
+    externalContents?: EventExternalContent[];
 }

src/lib/arianeeMessage-i18n.d.ts

 export interface ArianeeMessageI18N {
     $schema: string;
-    language?: LanguageCode;
+    language?: MessageLanguageCode;
     title?: string;
     content?: string;
-    i18n?: i18nContent[];
-    pictures?: Media[];
-    externalContents?: ExternalContent[];
+    i18n?: MessageI18nContent[];
+    pictures?: MessageMedia[];
+    externalContents?: MessageExternalContent[];
 }
-export type LanguageCode = 'fr-FR' | 'en-US' | 'zh-TW' | 'zh-CN' | 'ko-KR' | 'ja-JP' | 'de-DE' | 'es' | 'it';
-export type MediaType = 'picture' | 'youtube';
-export type ExternalContentType = 'website' | 'proofLinkAction' | 'arianeeAccessTokenAuthLink' | 'actionButton';
-export interface ExternalContent {
-    type: ExternalContentType;
+export type MessageLanguageCode = 'fr-FR' | 'en-US' | 'zh-TW' | 'zh-CN' | 'ko-KR' | 'ja-JP' | 'de-DE' | 'es' | 'it';
+export type MessageMediaType = 'picture' | 'youtube';
+export type MessageExternalContentType = 'website' | 'proofLinkAction' | 'arianeeAccessTokenAuthLink' | 'actionButton';
+export interface MessageExternalContent {
+    type: MessageExternalContentType;
     title: string;
@@ -19,4 +19,4 @@ url: string;
 }
-export interface Media {
-    mediaType: MediaType;
+export interface MessageMedia {
+    mediaType: MessageMediaType;
     type: 'product';
@@ -26,7 +26,7 @@ url: string;
 }
-export interface i18nContent {
-    language: LanguageCode;
+export interface MessageI18nContent {
+    language: MessageLanguageCode;
     title?: string;
     content?: string;
-    externalContents?: ExternalContent[];
+    externalContents?: MessageExternalContent[];
 }

src/lib/arianeeProductCertificate-i18n.d.ts

 export interface ArianeeProductCertificateI18N {
     $schema: string;
-    language?: LanguageCode;
+    language?: ProductLanguageCode;
     name?: string;
@@ -8,7 +8,7 @@ sku?: string;
     brandInternalId?: string;
-    category?: Category;
-    subCategory?: SubCategory;
-    intended?: Intended;
+    category?: ProductCategory;
+    subCategory?: ProductSubCategory;
+    intended?: ProductIntended;
     serialnumber?: Array<{
-        type: SerialNumberType;
+        type: ProductSerialNumberType;
         value: string;
@@ -19,20 +19,20 @@ }>;
     description?: string;
-    subDescription?: SubDescription[];
-    externalContents?: ExternalContent[];
+    subDescription?: ProductSubDescription[];
+    externalContents?: ProductExternalContent[];
     msrp?: Array<{
         msrp: string;
-        currency: Currency;
+        currency: ProductCurrency;
         msrpCountry: string;
     }>;
-    medias?: Media[];
-    customAttributes?: CustomAttribute[];
-    attributes?: AttributeType[];
-    materials?: Material[];
-    size?: Size[];
+    medias?: ProductMedia[];
+    customAttributes?: ProductCustomAttribute[];
+    attributes?: ProductAttributeType[];
+    materials?: ProductMaterial[];
+    size?: ProductSize[];
     manufacturingCountry?: string;
     facilityId?: string;
     productCertification?: ProductCertification[];
-    transparencyItems?: TransparencyItem[];
-    i18n?: I18n[];
-    parentCertificates?: ParentCertificate[];
+    transparencyItems?: ProductTransparencyItem[];
+    i18n?: ProductI18n[];
+    parentCertificates?: ProductParentCertificate[];
     image?: string;
@@ -45,18 +45,18 @@ image_data?: string;
 }
-export type LanguageCode = 'fr-FR' | 'en-US' | 'zh-TW' | 'zh-CN' | 'ko-KR' | 'ja-JP' | 'de-DE' | 'es' | 'it' | 'ru';
-export type Category = 'apparel' | 'accessory' | string;
-export type SubCategory = 'shirt' | 'dress' | 'watch';
-export type Intended = 'womens' | 'mens' | 'neutral';
-export type SerialNumberType = 'serialnumber' | 'casenumber' | 'movementnumber' | 'vin' | 'pgeneve' | 'millesimation';
-export type SubDescriptionType = 'service' | 'recycling' | 'other';
-export type Currency = 'USD' | 'EUR' | 'GBP';
-export type MediaType = 'picture' | 'youtube' | '3dModel' | 'video';
-export type MediaTypeEnum = 'product' | 'brandItemBackgroundPicture' | 'itemBackgroundPicture' | 'certificateBackgroundPicture' | '3dModelPreview' | '3dModelAsset' | 'videoPreview' | 'videoSource';
-export type MaterialEnum = 'cashmere' | 'cotton' | 'denim-jeans' | 'gold' | 'silver';
-export type SizeTypeEnum = 'height' | 'width' | 'depth' | 'size';
-export type UnitEnum = 'in' | 'cm' | 'mm' | 'eu' | 'uk' | 'us';
-export type CertificationEnum = 'fairtrade' | 'wwf';
-export interface Media {
-    mediaType: MediaType;
-    type: MediaTypeEnum;
+export type ProductLanguageCode = 'fr-FR' | 'en-US' | 'zh-TW' | 'zh-CN' | 'ko-KR' | 'ja-JP' | 'de-DE' | 'es' | 'it' | 'ru';
+export type ProductCategory = 'apparel' | 'accessory' | string;
+export type ProductSubCategory = 'shirt' | 'dress' | 'watch';
+export type ProductIntended = 'womens' | 'mens' | 'neutral';
+export type ProductSerialNumberType = 'serialnumber' | 'casenumber' | 'movementnumber' | 'vin' | 'pgeneve' | 'millesimation';
+export type ProductSubDescriptionType = 'service' | 'recycling' | 'other';
+export type ProductCurrency = 'USD' | 'EUR' | 'GBP';
+export type ProductMediaType = 'picture' | 'youtube' | '3dModel' | 'video';
+export type ProductMediaTypeEnum = 'product' | 'brandItemBackgroundPicture' | 'itemBackgroundPicture' | 'certificateBackgroundPicture' | '3dModelPreview' | '3dModelAsset' | 'videoPreview' | 'videoSource';
+export type ProductMaterialEnum = 'cashmere' | 'cotton' | 'denim-jeans' | 'gold' | 'silver';
+export type ProductSizeTypeEnum = 'height' | 'width' | 'depth' | 'size';
+export type ProductUnitEnum = 'in' | 'cm' | 'mm' | 'eu' | 'uk' | 'us';
+export type ProductCertificationEnum = 'fairtrade' | 'wwf';
+export interface ProductMedia {
+    mediaType: ProductMediaType;
+    type: ProductMediaTypeEnum;
     url: string;
@@ -66,7 +66,7 @@ hash?: string;
 }
-export interface CustomAttribute {
+export interface ProductCustomAttribute {
     type: string;
     value: string;
 }
-export type AttributeType = {
+export type ProductAttributeType = {
     trait_type?: string;
@@ -76,25 +76,25 @@ type?: 'color' | 'printed' | 'complication';
 };
-export interface Material {
-    material: MaterialEnum;
+export interface ProductMaterial {
+    material: ProductMaterialEnum;
     value: string;
     pourcentage: string;
 }
-export interface Size {
-    type: SizeTypeEnum;
+export interface ProductSize {
+    type: ProductSizeTypeEnum;
     value: string;
-    unit: UnitEnum;
+    unit: ProductUnitEnum;
 }
 export interface ProductCertification {
-    name: CertificationEnum;
+    name: ProductCertificationEnum;
 }
-export type TransparencyCategory = 'material' | 'assembly' | 'impact';
-export type TransparencyType = 'responsible_procurement' | 'eco_design' | 'packaging';
-export type TransparencySubtype = 'material-responsible_procurement-ethical_purchasing' | 'material-responsible_procurement-organic organic';
-export type TransparencyMediaTypeEnum = 'icon' | 'transparencyPicture';
-export type ExternalContentTypeEnum = 'website' | 'proofLinkAction' | 'transparency' | 'arianeeAccessTokenAuthLink' | 'youtube' | 'authRedirectTo';
-export interface TransparencyMedia extends Omit<Media, 'type'> {
-    type: TransparencyMediaTypeEnum;
+export type ProductTransparencyCategory = 'material' | 'assembly' | 'impact';
+export type ProductTransparencyType = 'responsible_procurement' | 'eco_design' | 'packaging';
+export type ProductTransparencySubtype = 'material-responsible_procurement-ethical_purchasing' | 'material-responsible_procurement-organic organic';
+export type ProductTransparencyMediaTypeEnum = 'icon' | 'transparencyPicture';
+export type ProductExternalContentTypeEnum = 'website' | 'proofLinkAction' | 'transparency' | 'arianeeAccessTokenAuthLink' | 'youtube' | 'authRedirectTo';
+export interface ProductTransparencyMedia extends Omit<ProductMedia, 'type'> {
+    type: ProductTransparencyMediaTypeEnum;
 }
-export interface ExternalContent {
-    type: ExternalContentTypeEnum;
+export interface ProductExternalContent {
+    type: ProductExternalContentTypeEnum;
     title: string;
@@ -104,15 +104,15 @@ url: string;
 }
-export interface TransparencyItem {
-    category: TransparencyCategory;
-    type: TransparencyType;
-    subtype: TransparencySubtype;
+export interface ProductTransparencyItem {
+    category: ProductTransparencyCategory;
+    type: ProductTransparencyType;
+    subtype: ProductTransparencySubtype;
     title: string;
     subtitle: string;
     description: string;
-    medias: TransparencyMedia[];
-    externalContents?: ExternalContent[];
+    medias: ProductTransparencyMedia[];
+    externalContents?: ProductExternalContent[];
 }
-export type ParentCertificateType = 'full' | 'Full';
-export type SubDescription = {
-    type: SubDescriptionType;
+export type ProductParentCertificateType = 'full' | 'Full';
+export type ProductSubDescription = {
+    type: ProductSubDescriptionType;
     title: string;
@@ -122,9 +122,9 @@ content: string;
 };
-export interface ParentCertificate {
-    type: ParentCertificateType;
+export interface ProductParentCertificate {
+    type: ProductParentCertificateType;
     arianeeLink: string;
     order?: number;
 }
-export interface I18n {
-    language: LanguageCode;
+export interface ProductI18n {
+    language: ProductLanguageCode;
     name?: string;
@@ -134,7 +134,7 @@ model?: string;
     description?: string;
-    subDescription?: SubDescription[];
-    medias?: Media[];
-    externalContents?: ExternalContent[];
-    customAttributes?: CustomAttribute[];
-    transparencyItems?: TransparencyItem[];
+    subDescription?: ProductSubDescription[];
+    medias?: ProductMedia[];
+    externalContents?: ProductExternalContent[];
+    customAttributes?: ProductCustomAttribute[];
+    transparencyItems?: ProductTransparencyItem[];
 }

src/lib/protocol.d.ts

@@ -5,1 +5,2 @@ export type Protocol = {
 };
+export type ChainType = 'mainnet' | 'testnet';

No alert changes

Improved metrics

Total package byte prevSize

16050

increased by9.35%

Lines of code

390

increased by3.17%

No dependency changes