@aptly-as/types 1.1.6 → 1.2.3

package/models/index.d.ts

@@ -3,6 +3,7 @@ export * from './client';
 export * from './document';
 export * from './extends';
 export * from './inquiry';
+export * from './media';
 export * from './notification-trigger';
 export * from './option-label';
 export * from './order';

package/models/index.js

@@ -8,6 +8,7 @@ __export(require("./client"));
 __export(require("./document"));
 __export(require("./extends"));
 __export(require("./inquiry"));
+__export(require("./media"));
 __export(require("./notification-trigger"));
 __export(require("./option-label"));
 __export(require("./order"));

package/models/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;;;AACA,+BAA0B;AAC1B,8BAAyB;AACzB,gCAA2B;AAC3B,+BAA0B;AAC1B,+BAA0B;AAC1B,4CAAuC;AACvC,oCAA+B;AAC/B,6BAAwB;AACxB,oCAA+B;AAC/B,4BAAuB;AACvB,gCAA2B;AAC3B,+BAA0B;AAC1B,qCAAgC;AAChC,+BAA0B;AAC1B,sCAAiC;AACjC,gCAA2B;AAC3B,2BAAsB;AACtB,4BAAuB;AACvB,qCAAgC;AAChC,kCAA6B;AAC7B,uCAAkC;AAClC,4BAAuB;AACvB,+BAA0B;AAC1B,qCAAgC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;;;AACA,+BAA0B;AAC1B,8BAAyB;AACzB,gCAA2B;AAC3B,+BAA0B;AAC1B,+BAA0B;AAC1B,6BAAwB;AACxB,4CAAuC;AACvC,oCAA+B;AAC/B,6BAAwB;AACxB,oCAA+B;AAC/B,4BAAuB;AACvB,gCAA2B;AAC3B,+BAA0B;AAC1B,qCAAgC;AAChC,+BAA0B;AAC1B,sCAAiC;AACjC,gCAA2B;AAC3B,2BAAsB;AACtB,4BAAuB;AACvB,qCAAgC;AAChC,kCAA6B;AAC7B,uCAAkC;AAClC,4BAAuB;AACvB,+BAA0B;AAC1B,qCAAgC"}

package/models/index.ts

@@ -4,6 +4,7 @@ export * from './client';
 export * from './document';
 export * from './extends';
 export * from './inquiry';
+export * from './media';
 export * from './notification-trigger';
 export * from './option-label';
 export * from './order';

package/models/media.d.ts

@@ -0,0 +1,51 @@
+import { AptlyOrganizationSchema } from './organization';
+export interface AptlyMediaSchema<ID, DATE> {
+    _id: ID;
+    archived: boolean;
+    created: DATE;
+    updated: DATE;
+    organization: ID | AptlyOrganizationSchema<ID, DATE>;
+    src: string;
+    name: string;
+    alt: string;
+    caption?: string;
+    title?: string;
+    mime: string;
+    tags: string[];
+    width: number;
+    height: number;
+    albums: string[];
+    public_id: string;
+    asset_id: string;
+    version: number;
+    version_id: string;
+    signature: string;
+    format: string;
+    resource_type: string;
+    created_at: string;
+    bytes: number;
+    type: string;
+    etag: string;
+    placeholder: boolean;
+    url: string;
+    original_filename: string;
+    srcUrl?: string;
+    uploadSignature?: string;
+}
+export interface AptlyMediaSrcArea {
+    width: number;
+    height: number;
+    x: number;
+    y: number;
+}
+export interface AptlyMediaSrcLocation {
+    x: number;
+    y: number;
+}
+export interface AptlyMediaSrcSchema<ID, DATE> extends Pick<AptlyMediaSchema<ID, DATE>, AptlyMediaSrcKeys> {
+    area?: AptlyMediaSrcArea;
+    location?: AptlyMediaSrcLocation;
+}
+export declare type AptlyMediaSrcKeys = '_id' | 'name' | 'src' | 'url' | 'alt' | 'title' | 'caption' | 'mime' | 'width' | 'height';
+export declare type AptlyMediaSrc = AptlyMediaSrcSchema<string, string>;
+export declare type AptlyMedia = AptlyMediaSchema<string, string>;

package/models/media.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=media.js.map

package/models/media.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"media.js","sourceRoot":"","sources":["media.ts"],"names":[],"mappings":""}

package/models/media.ts

@@ -0,0 +1,61 @@
+import { AptlyOrganizationSchema } from './organization';
+
+export interface AptlyMediaSchema<ID, DATE> {
+  // Aptly data
+  _id: ID;
+  archived: boolean;
+  created: DATE;
+  updated: DATE;
+  organization: ID | AptlyOrganizationSchema<ID, DATE>;
+  src: string;
+  name: string;
+  alt: string;
+  caption?: string;
+  title?: string;
+  mime: string;
+  tags: string[];
+  width: number;
+  height: number;
+  albums: string[];
+
+  // Cloudinary datayarn sta
+  public_id: string;
+  asset_id: string;
+  version: number;
+  version_id: string;
+  signature: string;
+  format: string;
+  resource_type: string;
+  created_at: string;
+  bytes: number;
+  type: string;
+  etag: string;
+  placeholder: boolean;
+  url: string;
+  original_filename: string;
+
+  // Aptly recognize help values
+  srcUrl?: string; // Recognize image if uploaded with url.
+  uploadSignature?: string; // Recognize images with buffer content
+}
+
+export interface AptlyMediaSrcArea {
+  width: number;
+  height: number;
+  x: number;
+  y: number;
+}
+
+export interface AptlyMediaSrcLocation {
+  x: number;
+  y: number;
+}
+
+export interface AptlyMediaSrcSchema<ID, DATE> extends Pick<AptlyMediaSchema<ID, DATE>, AptlyMediaSrcKeys> {
+  area?: AptlyMediaSrcArea;
+  location?: AptlyMediaSrcLocation;
+}
+
+export type AptlyMediaSrcKeys = '_id' | 'name' | 'src' | 'url' | 'alt' | 'title' | 'caption' | 'mime' | 'width' | 'height';
+export type AptlyMediaSrc = AptlyMediaSrcSchema<string, string>;
+export type AptlyMedia = AptlyMediaSchema<string, string>;

package/models/option-label.d.ts

@@ -3,6 +3,7 @@ export interface AptlyOptionLabelSchema<ID, DATE> {
     _id: ID;
     name: string;
     created: DATE;
-    organization: string;
+    organization?: string;
     project?: string;
+    archived?: boolean;
 }

package/models/option-label.ts

@@ -4,6 +4,7 @@ export interface AptlyOptionLabelSchema<ID, DATE> {
   _id: ID;
   name: string;
   created: DATE;
-  organization: string;
+  organization?: string;
   project?: string;
+  archived?: boolean;
 }

package/models/organization.d.ts

@@ -1,12 +1,14 @@
 import { AptlyPermissionModulesModels, AptlyPermissionOrganizationModels } from '../core';
 import { AptlySignageSchema } from '../core/signage';
 import { AptlyUserSchema } from './user';
+import { AptlyMediaSrc } from './media';
 export declare type AptlyOrganization = AptlyOrganizationSchema<string, string>;
 export interface AptlyOrganizationSchema<ID, DATE> {
     _id: ID;
     name: string;
     slug: string;
-    logo: string;
+    logo?: string | null;
+    logoMedia?: AptlyMediaSrc | null;
     address: {
         visit: {
             street: string;
@@ -37,6 +39,7 @@ export interface AptlyOrganizationIntegrationsSchema<ID> {
 }
 export declare type AptlyOrganizationMember = AptlyOrganizationMemberSchema<string, string>;
 export interface AptlyOrganizationMemberSchema<ID, DATE> {
+    _id: ID;
     user: AptlyUserSchema<ID, DATE> | ID;
-    permissions: number | AptlyPermissionOrganizationModels | AptlyPermissionOrganizationModels[];
+    permissions: AptlyPermissionOrganizationModels[];
 }

package/models/organization.ts

@@ -1,13 +1,15 @@
 import { AptlyPermissionModulesModels, AptlyPermissionOrganizationModels } from '../core';
 import { AptlySignageSchema } from '../core/signage';
 import { AptlyUserSchema } from './user';
+import { AptlyMediaSrc } from './media';
 
 export type AptlyOrganization = AptlyOrganizationSchema<string, string>;
 export interface AptlyOrganizationSchema<ID, DATE> {
   _id: ID;
   name: string;
   slug: string;
-  logo: string;
+  logo?: string | null;
+  logoMedia?: AptlyMediaSrc | null;
   address: {
     visit: {
       street: string;
@@ -40,6 +42,7 @@ export interface AptlyOrganizationIntegrationsSchema<ID> {
 
 export type AptlyOrganizationMember = AptlyOrganizationMemberSchema<string, string>;
 export interface AptlyOrganizationMemberSchema<ID, DATE> {
+  _id: ID;
   user: AptlyUserSchema<ID, DATE> | ID;
-  permissions: number | AptlyPermissionOrganizationModels | AptlyPermissionOrganizationModels[];
+  permissions: AptlyPermissionOrganizationModels[];
 }

package/models/page.d.ts

@@ -5,12 +5,13 @@ export interface AptlyPageSchema<ID, DATE> {
     slug: string;
     name: string;
     project: ID;
+    organization: ID;
     showInMenu: boolean;
     summary: string;
     icon?: string;
     legacy?: string;
     image?: string;
-    upsellTemplate: ID;
+    upsellTemplate?: ID | null;
     sections: AptlyPageSectionSchema<ID, DATE>[];
     archived?: boolean;
 }

package/models/page.ts

@@ -6,12 +6,13 @@ export interface AptlyPageSchema<ID, DATE> {
   slug: string;
   name: string;
   project: ID;
+  organization: ID;
   showInMenu: boolean;
   summary: string;
   icon?: string;
   legacy?: string; // Deprecated
   image?: string; // Deprecated
-  upsellTemplate: ID;
+  upsellTemplate?: ID | null;
   sections: AptlyPageSectionSchema<ID, DATE>[];
   archived?: boolean;
 }

package/models/producer.d.ts

@@ -1,14 +1,20 @@
 import { AptlyHistorySchema } from './extends';
+import { AptlyMediaSrc } from './media';
 export declare type AptlyProducer = AptlyProducerSchema<string, string>;
 export interface AptlyProducerSchema<ID, DATE> extends AptlyHistorySchema<ID, DATE> {
     _id: ID;
     name: string;
     email: string;
-    logo: string;
+    logo: string | null;
+    logoMedia?: AptlyMediaSrc | null;
+    url?: string;
     created: DATE;
-    organization: ID;
-    extends: ID;
+    organization?: ID;
     archived: boolean;
     createdBy: ID;
     tags: ID[];
+    /**
+     * @deprecated not used
+     */
+    extends: ID;
 }

package/models/producer.ts

@@ -1,15 +1,21 @@
 import { AptlyHistorySchema } from './extends';
+import { AptlyMediaSrc } from './media';
 
 export type AptlyProducer = AptlyProducerSchema<string, string>;
 export interface AptlyProducerSchema<ID, DATE> extends AptlyHistorySchema<ID, DATE> {
   _id: ID;
   name: string;
   email: string;
-  logo: string;
+  logo: string | null;
+  logoMedia?: AptlyMediaSrc | null;
+  url?: string;
   created: DATE;
-  organization: ID;
-  extends: ID;
+  organization?: ID;
   archived: boolean;
   createdBy: ID;
   tags: ID[];
+  /**
+   * @deprecated not used
+   */
+  extends: ID;
 }

package/models/product.d.ts

@@ -1,4 +1,5 @@
 import { AptlyDBCrawlerCleaner, AptlyHistorySchema } from './extends';
+import { AptlyMediaSrcSchema } from './media';
 export declare type AptlyProduct = AptlyProductSchema<string, string>;
 export interface AptlyProductSchema<ID, DATE> extends AptlyDBCrawlerCleaner, AptlyHistorySchema<ID, DATE> {
     _id: ID;
@@ -10,7 +11,7 @@ export interface AptlyProductSchema<ID, DATE> extends AptlyDBCrawlerCleaner, Apt
     extends?: ID;
     productNumber: string;
     description: string;
-    images: IProductImageSchema<ID>[];
+    images: AptlyProductImageSchema<ID, DATE>[];
     variants: AptlyProductVariantSchema<ID, DATE>[];
     color?: string;
     colorLabel?: string;
@@ -37,18 +38,18 @@ export interface AptlyProductSchema<ID, DATE> extends AptlyDBCrawlerCleaner, Apt
     stats?: any;
     importID?: ID;
 }
-export declare type IProductImage = IProductImageSchema<string>;
-export interface IProductImageSchema<ID> {
-    _id: ID;
+export declare type AptlyProductImage = AptlyProductImageSchema<string, string>;
+export interface AptlyProductImageSchema<ID, DATE> extends AptlyMediaSrcSchema<ID, DATE> {
     image: string;
-    description: string;
-    featured: boolean;
+    description?: string;
+    featured?: boolean;
 }
 export declare type AptlyProductVariant = AptlyProductVariantSchema<string, string>;
 export interface AptlyProductVariantSchema<ID, DATE> {
     _id: ID;
-    images: IProductImageSchema<ID>[];
     title: string;
+    images: AptlyProductImageSchema<ID, DATE>[];
+    documents: ID[];
     name?: string;
     description?: string;
     productNumber?: string;

package/models/product.ts

@@ -1,4 +1,5 @@
 import { AptlyDBCrawlerCleaner, AptlyHistorySchema } from './extends';
+import { AptlyMediaSrcSchema } from './media';
 
 export type AptlyProduct = AptlyProductSchema<string, string>;
 export interface AptlyProductSchema<ID, DATE> extends AptlyDBCrawlerCleaner, AptlyHistorySchema<ID, DATE> {
@@ -11,7 +12,7 @@ export interface AptlyProductSchema<ID, DATE> extends AptlyDBCrawlerCleaner, Apt
   extends?: ID;
   productNumber: string;
   description: string;
-  images: IProductImageSchema<ID>[];
+  images: AptlyProductImageSchema<ID, DATE>[];
   variants: AptlyProductVariantSchema<ID, DATE>[];
   color?: string;
   colorLabel?: string;
@@ -39,19 +40,19 @@ export interface AptlyProductSchema<ID, DATE> extends AptlyDBCrawlerCleaner, Apt
   importID?: ID;
 }
 
-export type IProductImage = IProductImageSchema<string>;
-export interface IProductImageSchema<ID> {
-  _id: ID;
+export type AptlyProductImage = AptlyProductImageSchema<string, string>;
+export interface AptlyProductImageSchema<ID, DATE> extends AptlyMediaSrcSchema<ID, DATE> {
   image: string;
-  description: string;
-  featured: boolean;
+  description?: string;
+  featured?: boolean;
 }
 
 export type AptlyProductVariant = AptlyProductVariantSchema<string, string>;
 export interface AptlyProductVariantSchema<ID, DATE> {
   _id: ID;
-  images: IProductImageSchema<ID>[];
   title: string;
+  images: AptlyProductImageSchema<ID, DATE>[];
+  documents: ID[];
 
   name?: string;
   description?: string;

package/models/project.d.ts

@@ -4,6 +4,7 @@ import { AptlyUserSchema } from './user';
 import { AptlyHistorySchema } from './extends';
 import { AptlyDocumentSchema } from './document';
 import { AptlyUnitOptionExtraItemSchema } from './unit';
+import { AptlyMediaSrc } from './media';
 export declare type AptlyProject = AptlyProjectSchema<string, string>;
 export interface AptlyProjectSchema<ID, DATE> extends AptlyHistorySchema<ID, DATE> {
     _id: ID;
@@ -69,13 +70,16 @@ export interface AptlyProjectTheme {
         tertiary?: string;
         links?: [string];
     };
-    images?: {
-        logo?: string;
-        largeLogo?: string;
-        hero?: string;
-        fallback?: string;
+    images: {
+        logo?: string | null;
+        logoMedia?: AptlyMediaSrc | null;
+        largeLogo?: string | null;
+        hero?: string | null;
+        heroMedia?: AptlyMediaSrc | null;
+        fallback?: string | null;
+        fallbackMedia?: AptlyMediaSrc | null;
     };
-    contact?: {
+    contact: {
         name?: string;
         phone?: string;
         mail?: string;

package/models/project.ts

@@ -4,6 +4,7 @@ import { AptlyUserSchema } from './user';
 import { AptlyHistorySchema } from './extends';
 import { AptlyDocumentSchema } from './document';
 import { AptlyUnitOptionExtraItemSchema } from './unit';
+import { AptlyMediaSrc } from './media';
 
 export type AptlyProject = AptlyProjectSchema<string, string>;
 export interface AptlyProjectSchema<ID, DATE> extends AptlyHistorySchema<ID, DATE> {
@@ -74,13 +75,16 @@ export interface AptlyProjectTheme {
     tertiary?: string;
     links?: [string];
   };
-  images?: {
-    logo?: string;
-    largeLogo?: string;
-    hero?: string;
-    fallback?: string;
+  images: {
+    logo?: string | null;
+    logoMedia?: AptlyMediaSrc | null;
+    largeLogo?: string | null;
+    hero?: string | null;
+    heroMedia?: AptlyMediaSrc | null;
+    fallback?: string | null;
+    fallbackMedia?: AptlyMediaSrc | null;
   };
-  contact?: {
+  contact: {
     name?: string;
     phone?: string;
     mail?: string;

package/models/recommendation.d.ts

@@ -1,11 +1,14 @@
+import { AptlyMediaSrc } from './media';
 export declare type AptlyRecommendation = AptlyRecommendationSchema<string, string>;
 export interface AptlyRecommendationSchema<ID, DATE> {
     _id: ID;
-    project: ID;
+    organization?: ID;
+    project?: ID;
     title: string;
     name: string;
     color: string;
     text: string;
-    image: string;
+    image?: string | null;
+    imageMedia?: AptlyMediaSrc | null;
     archived?: boolean;
 }

package/models/recommendation.ts

@@ -1,12 +1,15 @@
+import { AptlyMediaSrc } from './media';
 
 export type AptlyRecommendation = AptlyRecommendationSchema<string, string>;
 export interface AptlyRecommendationSchema<ID, DATE> {
   _id: ID;
-  project: ID;
+  organization?: ID;
+  project?: ID;
   title: string;
   name: string;
   color: string;
   text: string;
-  image: string;
+  image?: string | null;
+  imageMedia?: AptlyMediaSrc | null;
   archived?: boolean;
 }

package/models/supplier.d.ts

@@ -1,9 +1,11 @@
+import { AptlyMediaSrc } from './media';
 export declare type AptlySupplier = AptlySupplierSchema<string, string>;
 export interface AptlySupplierSchema<ID, DATE> {
     _id: ID;
     name: string;
     email?: string;
     logo: string | null;
+    logoMedia?: AptlyMediaSrc | null;
     created: DATE;
     archived: boolean;
     createdBy: ID;

package/models/supplier.ts

@@ -1,3 +1,4 @@
+import { AptlyMediaSrc } from './media';
 
 export type AptlySupplier = AptlySupplierSchema<string, string>;
 export interface AptlySupplierSchema<ID, DATE> {
@@ -5,6 +6,7 @@ export interface AptlySupplierSchema<ID, DATE> {
   name: string;
   email?: string;
   logo: string | null;
+  logoMedia?: AptlyMediaSrc | null;
   created: DATE;
   archived: boolean;
   createdBy: ID;

package/models/upsell-template.d.ts

@@ -3,12 +3,17 @@ export declare type AptlyUpsellTemplate = AptlyUpsellTemplateSchema<string, stri
 export interface AptlyUpsellTemplateSchema<ID, DATE> extends AptlyHistorySchema<ID, DATE> {
     _id: ID;
     name: string;
+    /**
+     * @deprecated not used.. Only for frontend
+     */
     description: string;
-    image?: string;
+    image?: string | null;
+    imageMedia?: string | null;
     videoEmbed?: string;
     text?: string;
     links: ID[];
-    project: ID;
+    organization?: ID;
+    project?: ID;
     created: DATE;
     archived: boolean;
 }

package/models/upsell-template.ts

@@ -4,12 +4,17 @@ export type AptlyUpsellTemplate = AptlyUpsellTemplateSchema<string, string>;
 export interface AptlyUpsellTemplateSchema<ID, DATE> extends AptlyHistorySchema<ID, DATE> {
   _id: ID;
   name: string;
+  /**
+   * @deprecated not used.. Only for frontend
+   */
   description: string;
-  image?: string;
+  image?: string | null;
+  imageMedia?: string | null;
   videoEmbed?: string;
   text?: string;
   links: ID[];
-  project: ID;
+  organization?: ID;
+  project?: ID;
   created: DATE;
   archived: boolean;
 }

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@aptly-as/types",
-  "version": "1.1.6",
+  "version": "1.2.3",
   "description": "Aptly types and enums",
   "main": "./index.js",
   "types": "./index.d.ts",
+  "author": "Emil A. Olsen <emil@aptly.as>",
   "engines": {
     "node": ">14.0.0"
   },
@@ -18,6 +19,10 @@
     "postversion": "git push && git push --tags",
     "prepublish": "npm run build"
   },
+  "dependencies": {},
+  "devDependencies": {
+    "typescript": "^4.2.4"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/aptly-as/types.git"
@@ -27,11 +32,10 @@
     "aptly",
     "types"
   ],
-  "author": "Emil A. Olsen",
   "bugs": {
-    "url": "https://github.com/aptly-as/inwise-types/issues"
+    "url": "https://github.com/aptly-as/types/issues"
   },
-  "homepage": "https://github.com/aptly-as/inwise-types#readme",
+  "homepage": "https://github.com/aptly-as/types#readme",
   "files": [
     "core",
     "enums",
@@ -40,8 +44,5 @@
     "index.d.ts",
     "index.js",
     "index.js.map"
-  ],
-  "devDependencies": {
-    "typescript": "^4.2.4"
-  }
+  ]
 }