jourycms-sdk 1.0.1

package/typings/v1/services/content/entities/translation.project.d.ts

@@ -0,0 +1,98 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Content {
+        /**
+         * SubDomain Translation
+         */
+        export namespace Translation {
+          /**
+           * @description Service Entity
+           */
+          export namespace Entity {
+            export type TLanguageCode =
+              | "zh"
+              | "es"
+              | "en"
+              | "hi"
+              | "ar"
+              | "bn"
+              | "pt"
+              | "ru"
+              | "ja"
+              | "de"
+              | "ko"
+              | "fr"
+              | "tr"
+              | "vi"
+              | "ur"
+              | "it"
+              | "th"
+              | "gu"
+              | "pl"
+              | "uk"
+              | "ro"
+              | "nl"
+              | "el"
+              | "sv"
+              | "sr"
+              | "hu"
+              | "fa"
+              | "cs"
+              | "fi"
+              | "sk"
+              | "da"
+              | "bg"
+              | "no"
+              | "he"
+              | "id"
+              | "ms"
+              | "lv"
+              | "lt"
+              | "et"
+              | "hr"
+              | "sl"
+              | "mt"
+              | "is"
+              | "ga"
+              | "mk"
+              | "cy"
+              | "ne"
+              | "ml"
+              | "kn"
+              | "mr"
+              | "ta"
+              | "te"
+              | "pa"
+              | "sw"
+              | "ka"
+              | "am"
+              | "ti"
+              | "xh"
+              | "zu"
+              | "yi"
+              | "so"
+              | "sn"
+              | "ny"
+              | "st"
+              | "tn"
+              | "ts"
+              | "ss"
+              | "ve"
+              | "nr";
+
+            export interface Project
+              extends Utils.Entity.General.ICreatable,
+                Utils.Entity.General.IHasSearchMeta {
+              _id: Utils.Common.ID;
+              name: string;
+              description: string;
+              languages: LanguageCode[];
+              default_language: LanguageCode;
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/content/index.d.ts

@@ -0,0 +1,5 @@
+'generated by levelup';
+
+export * from "./models/index.d.ts";
+export * from "./entities/index.d.ts";
+export * from "./api/index.d.ts";

package/typings/v1/services/content/models/article-type.d.ts

@@ -0,0 +1,19 @@
+import { Document, Model as MongooseModel } from "mongoose";
+
+/**
+ * @description global here is very important because we have imported from another module
+ */
+declare global {
+  declare module Levelup {
+    namespace CMS {
+      namespace V1 {
+        namespace Content {
+          export namespace Model {
+            export type ArticleTypeDocument = Entity.ArticleType & Document;
+            export type ArticleType = MongooseModel<ArticleTypeDocument>;
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/content/models/article.d.ts

@@ -0,0 +1,19 @@
+import { Document, Model as MongooseModel } from "mongoose";
+
+/**
+ * @description global here is very important because we have imported from another module
+ */
+declare global {
+  declare module Levelup {
+    namespace CMS {
+      namespace V1 {
+        namespace Content {
+          export namespace Model {
+            export type ArticleDocument = Entity.Article & Document;
+            export type Article = MongooseModel<ArticleDocument>;
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/content/models/comment.d.ts

@@ -0,0 +1,19 @@
+import { Document, Model as MongooseModel } from "mongoose";
+
+/**
+ * @description global here is very important because we have imported from another module
+ */
+declare global {
+  declare module Levelup {
+    namespace CMS {
+      namespace V1 {
+        namespace Content {
+          export namespace Model {
+            export type CommentDocument = Entity.Comment & Document;
+            export type Comment = MongooseModel<CommentDocument>;
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/content/models/index.d.ts

@@ -0,0 +1,11 @@
+'generated by levelup';
+
+export * from "./translation.project.d.ts";
+export * from "./translation.namespace.d.ts";
+export * from "./translation.item.d.ts";
+export * from "./taxonomy.d.ts";
+export * from "./term.d.ts";
+export * from "./review.d.ts";
+export * from "./comment.d.ts";
+export * from "./article.d.ts";
+export * from "./article-type.d.ts";

package/typings/v1/services/content/models/review.d.ts

@@ -0,0 +1,19 @@
+import { Document, Model as MongooseModel } from "mongoose";
+
+/**
+ * @description global here is very important because we have imported from another module
+ */
+declare global {
+  declare module Levelup {
+    namespace CMS {
+      namespace V1 {
+        namespace Content {
+          export namespace Model {
+            export type ReviewDocument = Entity.Review & Document;
+            export type Review = MongooseModel<ReviewDocument>;
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/content/models/taxonomy.d.ts

@@ -0,0 +1,19 @@
+import { Document, Model as MongooseModel } from "mongoose";
+
+/**
+ * @description global here is very important because we have imported from another module
+ */
+declare global {
+  declare module Levelup {
+    namespace CMS {
+      namespace V1 {
+        namespace Content {
+          export namespace Model {
+            export type TaxonomyDocument = Entity.Taxonomy & Document;
+            export type Taxonomy = MongooseModel<TaxonomyDocument>;
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/content/models/term.d.ts

@@ -0,0 +1,19 @@
+import { Document, Model as MongooseModel } from "mongoose";
+
+/**
+ * @description global here is very important because we have imported from another module
+ */
+declare global {
+  declare module Levelup {
+    namespace CMS {
+      namespace V1 {
+        namespace Content {
+          export namespace Model {
+            export type TermDocument = Entity.Term & Document;
+            export type Term = MongooseModel<TermDocument>;
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/content/models/translation.item.d.ts

@@ -0,0 +1,21 @@
+import { Document, Model as MongooseModel } from "mongoose";
+
+/**
+ * @description global here is very important because we have imported from another module
+ */
+declare global {
+  declare module Levelup {
+    namespace CMS {
+      namespace V1 {
+        namespace Content {
+          namespace Translation {
+            export namespace Model {
+              export type ItemDocument = Entity.Item & Document;
+              export type Item = MongooseModel<ItemDocument>;
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/content/models/translation.namespace.d.ts

@@ -0,0 +1,22 @@
+import { Document, Model as MongooseModel } from 'mongoose';
+
+/**
+ * @description global here is very important because we have imported from another module
+ */
+declare global {
+  declare module Levelup {
+    namespace CMS {
+      namespace V1 {
+        namespace Content {
+          namespace Translation {
+
+            export namespace Model {
+              export type NamespaceDocument = Entity.Namespace & Document;
+              export type Namespace = MongooseModel<NamespaceDocument>;
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/content/models/translation.project.d.ts

@@ -0,0 +1,21 @@
+import { Document, Model as MongooseModel } from "mongoose";
+
+/**
+ * @description global here is very important because we have imported from another module
+ */
+declare global {
+  declare module Levelup {
+    namespace CMS {
+      namespace V1 {
+        namespace Content {
+          namespace Translation {
+            export namespace Model {
+              export type ProjectDocument = Entity.Project & Document;
+              export type Project = MongooseModel<ProjectDocument>;
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./auth/index.d.ts";
+export * from "./content/index.d.ts";
+export * from "./storage/index.d.ts";
+export * from "./system/index.d.ts";

package/typings/v1/services/storage/api/index.d.ts

@@ -0,0 +1,3 @@
+"generated by levelup";
+
+export * from "./uploaded-file.d.ts";

package/typings/v1/services/storage/api/uploaded-file.d.ts

@@ -0,0 +1,166 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Storage {
+        export namespace Api {
+          /**
+           * --------------------------------------------------------------------------
+           *                            Upload
+           * --------------------------------------------------------------------------
+           * @link
+           * @fires UploadedFilesService.Upload
+           * @param {Levelup.V2.Storage.Api.Upload.Request} query
+           * @returns {Levelup.V2.Storage.Api.Upload.Response}
+           * @method POST
+           *
+           */
+          export namespace Upload {
+            export type Request = FormData;
+            export type Response = Utils.Api.Response.BuildSingleItemResponse<{
+              files: Entity.UploadedFile[];
+            }>;
+          }
+          /**
+           * --------------------------------------------------------------------------
+           *                            LoadRemote
+           * --------------------------------------------------------------------------
+           * @link
+           * @fires UploadedFilesService.LoadRemote
+           * @param {Levelup.V2.Storage.Api.LoadRemote.Request} query
+           * @returns {Levelup.V2.Storage.Api.LoadRemote.Response}
+           * @method POST
+           *
+           */
+          export namespace LoadRemote {
+            export type Request = Utils.Api.Request.BuildCreateRequest<{
+              url: string;
+            }>;
+            export type Response =
+              Utils.Api.Response.BuildSingleItemResponse<Entity.UploadedFile>;
+          }
+
+          export namespace UploadedFiles {
+            /**
+             * --------------------------------------------------------------------------
+             *                            Create
+             * --------------------------------------------------------------------------
+             * @link
+             * @fires UploadedFilesService.Create
+             * @param {Levelup.V2.Storage.Api.UploadedFiles.Create.Request} query
+             * @returns {Levelup.V2.Storage.Api.UploadedFiles.Create.Response}
+             * @method POST
+             *
+             */
+            export namespace Create {
+              export type Request =
+                Utils.Api.Request.BuildCreateRequest<Entity.UploadedFile>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<Entity.UploadedFile>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            Update
+             * --------------------------------------------------------------------------
+             * @link
+             * @fires UploadedFilesService.Update
+             * @param {Levelup.V2.Storage.Api.UploadedFiles.Update.Request} query
+             * @returns {Levelup.V2.Storage.Api.UploadedFiles.Update.Response}
+             * @method PUT
+             *
+             */
+            export namespace Update {
+              export type Request =
+                Utils.Api.Request.BuildUpdateRequest<Entity.UploadedFile>;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<Entity.UploadedFile>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            Delete
+             * --------------------------------------------------------------------------
+             * @link
+             * @fires UploadedFilesService.Delete
+             * @param {Levelup.V2.Storage.Api.UploadedFiles.Delete.Request} query
+             * @returns {Levelup.V2.Storage.Api.UploadedFiles.Delete.Response}
+             * @method DELETE
+             *
+             */
+            export namespace Delete {
+              export type Response = Utils.Api.Response.DefaultDeleteResponse;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            BulkDelete
+             * --------------------------------------------------------------------------
+             * @link
+             * @fires UploadedFilesService.BulkDelete
+             * @param {Levelup.V2.Storage.Api.UploadedFiles.BulkDelete.Request} query
+             * @returns {Levelup.V2.Storage.Api.UploadedFiles.BulkDelete.Response}
+             * @method DELETE
+             *
+             */
+            export namespace BulkDelete {
+              export type Request = Utils.Api.Request.Build<{
+                data: {
+                  id?: string[];
+                  tracking_id?: string[];
+                };
+              }>;
+              export type Response = Utils.Api.Response.DefaultDeleteResponse;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            GetOne
+             * --------------------------------------------------------------------------
+             * @link
+             * @fires UploadedFilesService.GetOne
+             * @param {Levelup.V2.Storage.Api.UploadedFiles.GetOne.Request} query
+             * @returns {Levelup.V2.Storage.Api.UploadedFiles.GetOne.Response}
+             * @method GET
+             *
+             */
+            export namespace GetOne {
+              type Scope = "";
+              export type Request = Utils.Api.Request.Build<
+                Record<string, unknown>
+              >;
+              export type Response =
+                Utils.Api.Response.BuildSingleItemResponse<Entity.UploadedFile>;
+            }
+
+            /**
+             * --------------------------------------------------------------------------
+             *                            List
+             * --------------------------------------------------------------------------
+             * @link
+             * @fires UploadedFilesService.List
+             * @param {Levelup.V2.Storage.Api.UploadedFiles.List.Request} query
+             * @returns {Levelup.V2.Storage.Api.UploadedFiles.List.Response}
+             * @method GET
+             *
+             */
+            export namespace List {
+              type Scope = "listing" | "ids" | "trackings";
+
+              export type Request =
+                Utils.Api.Request.BuildSearchablePagedSortableFilterableProjectable<Entity.UploadedFile> & {
+                  scope?: Scope;
+                  filters?: {
+                    /**
+                     * Here will be the custom filters
+                     */
+                  };
+                };
+              export type Response =
+                Utils.Api.Response.BuildListResponse<Entity.UploadedFile>;
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/storage/entities/index.d.ts

@@ -0,0 +1,3 @@
+"generated by levelup";
+
+export * from "./uploaded-file.d.ts";

package/typings/v1/services/storage/entities/uploaded-file.d.ts

@@ -0,0 +1,49 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Storage {
+        export namespace Entity {
+          export interface IUploadedFileAttributes {
+            store?: Utils.Common.ID;
+          }
+
+          export interface IUploadedFileSnapshots {
+            store?: Utils.Entity.Snapshots.Accounts.Store;
+          }
+
+          export interface UploadedFile
+            extends Utils.Entity.General.ICreatable,
+              Utils.Entity.General.IHasSearchMeta {
+            _id: Utils.Common.ID;
+            field_name: string;
+
+            original_name: string;
+            remote_url?: string;
+            /**
+             * The base file name with extension
+             */
+            file_name: string;
+            /**
+             * The relative path to the file
+             */
+            file_path: string;
+            /**
+             * The relative path to the file directory
+             */
+            destination: string;
+            /**
+             * File size in bytes
+             */
+            size: number;
+
+            caption: string;
+            encoding: string;
+            mimetype: string;
+            attributes: IUploadedFileAttributes;
+            snapshots: IUploadedFileSnapshots;
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/storage/index.d.ts

@@ -0,0 +1,5 @@
+'generated by levelup';
+
+export * from "./models/index.d.ts";
+export * from "./entities/index.d.ts";
+export * from "./api/index.d.ts";

package/typings/v1/services/storage/models/index.d.ts

@@ -0,0 +1,3 @@
+'generated by levelup';
+
+export * from "./uploaded-file.d.ts";

package/typings/v1/services/storage/models/uploaded-file.d.ts

@@ -0,0 +1,19 @@
+import { Document, Model as MongooseModel } from "mongoose";
+
+/**
+ * @description global here is very important because we have imported from another module
+ */
+declare global {
+  declare module Levelup {
+    namespace CMS {
+      namespace V1 {
+        namespace Storage {
+          export namespace Model {
+            export type UploadedFileDocument = Entity.UploadedFile & Document;
+            export type UploadedFile = MongooseModel<UploadedFileDocument>;
+          }
+        }
+      }
+    }
+  }
+}