jourycms-sdk 1.0.1

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

@@ -0,0 +1,196 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Content {
+        export namespace Translation {
+          /**
+           * @description Service Entity
+           */
+          export namespace Api {
+            export namespace Projects {
+              /**
+               * --------------------------------------------------------------------------
+               *                            Create
+               * --------------------------------------------------------------------------
+               * @link
+               * @fires ProjectsService.Create
+               * @param {Levelup.CMS.V1.Translation.Api.Projects.Create.Request} query
+               * @returns {Levelup.CMS.V1.Translation.Api.Projects.Create.Response}
+               * @method POST
+               *
+               */
+              export namespace Create {
+                export type Request =
+                  Utils.Api.Request.BuildCreateRequest<Entity.Project>;
+                export type Response =
+                  Utils.Api.Response.BuildSingleItemResponse<Entity.Project>;
+              }
+
+              /**
+               * --------------------------------------------------------------------------
+               *                            Update
+               * --------------------------------------------------------------------------
+               * @link
+               * @fires ProjectsService.Update
+               * @param {Levelup.CMS.V1.Translation.Api.Projects.Update.Request} query
+               * @returns {Levelup.CMS.V1.Translation.Api.Projects.Update.Response}
+               * @method PUT
+               *
+               */
+              export namespace Update {
+                export type Request =
+                  Utils.Api.Request.BuildUpdateRequest<Entity.Project>;
+                export type Response =
+                  Utils.Api.Response.BuildSingleItemResponse<Entity.Project>;
+              }
+
+              /**
+               * --------------------------------------------------------------------------
+               *                            Delete
+               * --------------------------------------------------------------------------
+               * @link
+               * @fires ProjectsService.Delete
+               * @param {Levelup.CMS.V1.Translation.Api.Projects.Delete.Request} query
+               * @returns {Levelup.CMS.V1.Translation.Api.Projects.Delete.Response}
+               * @method DELETE
+               *
+               */
+              export namespace Delete {
+                export type Response = Utils.Api.Response.DefaultDeleteResponse;
+              }
+
+              /**
+               * --------------------------------------------------------------------------
+               *                            BulkDelete
+               * --------------------------------------------------------------------------
+               * @link
+               * @fires ProjectsService.BulkDelete
+               * @param {Levelup.CMS.V1.Translation.Api.Projects.BulkDelete.Request} query
+               * @returns {Levelup.CMS.V1.Translation.Api.Projects.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 ProjectsService.GetOne
+               * @param {Levelup.CMS.V1.Translation.Api.Projects.GetOne.Request} query
+               * @returns {Levelup.CMS.V1.Translation.Api.Projects.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.Project>;
+              }
+
+              /**
+               * --------------------------------------------------------------------------
+               *                            List
+               * --------------------------------------------------------------------------
+               * @link
+               * @fires ProjectsService.List
+               * @param {Levelup.CMS.V1.Translation.Api.Projects.List.Request} query
+               * @returns {Levelup.CMS.V1.Translation.Api.Projects.List.Response}
+               * @method GET
+               *
+               */
+              export namespace List {
+                type Scope = "listing" | "ids" | "trackings";
+
+                export type Request =
+                  Utils.Api.Request.BuildSearchablePagedSortableFilterableProjectable<Entity.Project> & {
+                    updated_by?: string;
+                    created_by?: string;
+                    scope?: Scope;
+                    filters?: {
+                      /**
+                       * Here will be the custom filters
+                       */
+                    };
+                  };
+                export type Response =
+                  Utils.Api.Response.BuildListResponse<Entity.Project>;
+              }
+
+              export namespace GetTranslationProgress {
+                export type Request = Utils.Api.Request.Build<
+                  Partial<{
+                    project: string;
+                  }>
+                >;
+                export type Response =
+                  Utils.Api.Response.BuildSingleItemResponse<{
+                    total: number;
+                    translated: number;
+                    approved: number;
+
+                    languages: {
+                      [language: Entity.TLanguageCode]: {
+                        translated: number;
+                      };
+                    };
+
+                    namespaces: {
+                      [namespace: string]: {
+                        total: number;
+                        translated: number;
+                        approved: number;
+                      };
+                    };
+
+                    by_date: {
+                      [day: string]: {
+                        translated: number;
+                        approved: number;
+                      };
+                    };
+
+                    users: {
+                      [user: string]: {
+                        total: number;
+                        translated: number;
+                        approved: number;
+                      };
+                    };
+
+                    users_activity: {
+                      [user: string]: {
+                        day: string;
+                        updates: number;
+                      }[];
+                    };
+
+                    meta_data: {
+                      users: {
+                        [user: string]: Utils.Entity.Snapshots.Auth.User;
+                      };
+                      namespaces: {
+                        [namespace: string]: string;
+                      };
+                    };
+                  }>;
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/content/api/translation.tools.d.ts

@@ -0,0 +1,85 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Content {
+        export namespace Translation {
+          export namespace Api {
+            export namespace Tools {
+              export namespace InsertI18MissingKey {
+                export type Request = Utils.Api.Request.BuildCreateRequest<{
+                  project: string;
+                  namespace: string;
+                  key: string;
+                  languages: Entity.TLanguageCode[];
+                  default_language: Entity.TLanguageCode;
+                }>;
+                export type Response =
+                  Utils.Api.Response.BuildSingleItemResponse<Entity.Item>;
+              }
+            }
+            export namespace Insights {
+              export namespace GetTranslationProgress {
+                export type Request = Utils.Api.Request.Build<
+                  Partial<{
+                    project: string;
+                  }>
+                >;
+                export type Response =
+                  Utils.Api.Response.BuildSingleItemResponse<{
+                    total: number;
+                    translated: number;
+                    approved: number;
+
+                    languages: {
+                      [language: Entity.TLanguageCode]: {
+                        translated: number;
+                      };
+                    };
+
+                    namespaces: {
+                      [namespace: string]: {
+                        total: number;
+                        translated: number;
+                        approved: number;
+                      };
+                    };
+
+                    by_date: {
+                      [day: string]: {
+                        translated: number;
+                        approved: number;
+                      };
+                    };
+
+                    users: {
+                      [user: string]: {
+                        total: number;
+                        translated: number;
+                        approved: number;
+                      };
+                    };
+
+                    users_activity: {
+                      [user: string]: {
+                        day: string;
+                        updates: number;
+                      }[];
+                    };
+
+                    meta_data: {
+                      users: {
+                        [user: string]: Utils.Entity.Snapshots.Auth.User;
+                      };
+                      namespaces: {
+                        [namespace: string]: string;
+                      };
+                    };
+                  }>;
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,51 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Content {
+        export namespace Entity {
+          type ICustomMetaField = {
+            field_key: string;
+            field_label: string;
+            field_type: UI.Forms.CustomFields.CustomFieldType;
+            field_options: {
+              [Key: string]: any;
+            };
+          };
+
+          export interface IArticleTypeSnapshots {
+            created_by: Utils.Entity.Snapshots.Auth.User | null;
+          }
+
+          export interface IArticleTypeInsights {
+            article_count: number;
+          }
+
+          export interface ArticleType
+            extends Utils.Entity.General.ICreatable,
+              Utils.Entity.General.IHasSearchMeta {
+            _id: Utils.Common.ID;
+            slug: string;
+            name: string;
+            labels: {
+              singular: string;
+              plural: string;
+              list: string;
+              create: string;
+              edit: string;
+              delete: string;
+            };
+            description: string;
+            description_unformatted: string;
+            description_structured: { [Key: string]: any };
+
+            custom_meta_fields: ICustomMetaField[];
+            related_taxonomies: Utils.Common.ID[];
+
+            snapshots: IArticleTypeSnapshots;
+            insights: IArticleTypeInsights;
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,53 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Content {
+        export namespace Entity {
+          export interface IArticleAttributes {
+            google_index_requested?: boolean;
+          }
+          export interface IArticleSnapshots {
+            created_by: Utils.Entity.Snapshots.Auth.User | null;
+          }
+          export interface IArticleInsights {
+            comment_count?: number;
+            vote_count?: number;
+            vote_value?: number;
+            view_count?: number;
+          }
+
+          export interface Article
+            extends Utils.Entity.General.ICreatable,
+              Utils.Entity.General.IHasSearchMeta {
+            _type: Utils.Common.ID | null;
+            _id: Utils.Common.ID;
+            slug: string;
+            title: string;
+            body: string;
+            body_unformatted: string;
+            body_structured: { [Key: string]: any };
+
+            is_featured: boolean;
+
+            featured_image: Utils.Common.FileAttribute | null;
+
+            article_type: Utils.Common.ID;
+
+            related_tags: {
+              _id: Utils.Common.ID;
+              taxonomy: Utils.Common.ID;
+              name: string;
+              slug: string;
+            }[];
+
+            meta_fields: { [Key: string]: any };
+
+            attributes: IArticleAttributes;
+            snapshots: IArticleSnapshots;
+            insights: IArticleInsights;
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,34 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Content {
+        export namespace Entity {
+          export interface ICommentSnapshots {
+            created_by: Utils.Entity.Snapshots.Auth.User | null;
+            article: {
+              _id: Utils.Common.ID;
+              slug: string;
+              title: string;
+            };
+          }
+
+          export interface Comment
+            extends Utils.Entity.General.ICreatable,
+              Utils.Entity.General.IHasSearchMeta {
+            _id: Utils.Common.ID;
+            parent: Utils.Common.ID;
+            children: Utils.Common.ID[];
+            article: Utils.Common.ID;
+            slug: string;
+
+            body: string;
+            body_unformatted: string;
+            body_structured: { [Key: string]: any };
+
+            snapshots: ICommentSnapshots;
+          }
+        }
+      }
+    }
+  }
+}

package/typings/v1/services/content/entities/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/entities/review.d.ts

@@ -0,0 +1,35 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Content {
+        export namespace Entity {
+          export interface IReviewSnapshots {
+            created_by: Utils.Entity.Snapshots.Auth.User | null;
+            article: {
+              _id: Utils.Common.ID;
+              slug: string;
+              title: string;
+            };
+          }
+
+          export interface Review
+            extends Utils.Entity.General.ICreatable,
+              Utils.Entity.General.IHasSearchMeta {
+            _id: Utils.Common.ID;
+
+            article: Utils.Common.ID;
+            slug: string;
+
+            body: string;
+            body_unformatted: string;
+            body_structured: { [Key: string]: any };
+
+            value: number;
+
+            snapshots: IReviewSnapshots;
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,40 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Content {
+        export namespace Entity {
+          export interface ITaxonomySnapshots {
+            created_by: Utils.Entity.Snapshots.Auth.User | null;
+          }
+
+          export interface Taxonomy
+            extends Utils.Entity.General.ICreatable,
+              Utils.Entity.General.IHasSearchMeta {
+            _id: Utils.Common.ID;
+            slug: string;
+            name: string;
+
+            description: string;
+            description_unformatted: string;
+            description_structured: { [Key: string]: any };
+
+            // hierarchy
+            is_multi: boolean;
+            is_hierarchical: boolean;
+
+            labels: {
+              singular: string;
+              plural: string;
+              list: string;
+              add: string;
+              edit: string;
+              delete: string;
+            };
+            
+            snapshots: ITaxonomySnapshots;
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,43 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Content {
+        export namespace Entity {
+          export interface ITermSnapshots {
+            created_by: Utils.Entity.Snapshots.Auth.User | null;
+            taxonomy: {
+              _id: Utils.Common.ID;
+              slug: string;
+              name: string;
+              is_hierarchical: boolean;
+              is_multi: boolean;
+            };
+          }
+
+          export interface ITermInsights {
+            article_count: number;
+          }
+
+          export interface Term
+            extends Utils.Entity.General.ICreatable,
+              Utils.Entity.General.IHasSearchMeta {
+            // TODO finish this
+            _id: Utils.Common.ID;
+            taxonomy: Utils.Common.ID;
+            parent: Utils.Common.ID | null;
+            children: Utils.Common.ID[];
+            slug: string;
+            name: string;
+
+            description: string;
+            description_unformatted: string;
+            description_structured: { [Key: string]: any };
+
+            snapshots: ITermSnapshots;
+            insights: ITermInsights;
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,48 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Content {
+        /**
+         * SubDomain Translation
+         */
+        export namespace Translation {
+          export namespace Entity {
+            export interface IItemUpdateHistoryItem {
+              translation: string;
+              date: Date;
+              updated_by: Utils.Entity.Snapshots.Auth.User;
+              auto_translated: boolean;
+            }
+
+            export interface IItemTranslation {
+              language: LanguageCode;
+              translation: string;
+              date: Date;
+              is_auto_translated: boolean;
+              is_approved: boolean;
+              updated_by: Utils.Entity.Snapshots.Auth.User;
+              approved_by: Utils.Entity.Snapshots.Auth.User;
+              update_history: IItemUpdateHistoryItem[];
+            }
+
+            export interface Item
+              extends Utils.Entity.General.ICreatable,
+              Utils.Entity.General.IHasSearchMeta {
+              _id: Utils.Common.ID;
+              key: string;
+              project: Utils.Common.ID; // Project._id
+              namespace: string; // Namespace.name
+              comments: {
+                content: string;
+                user: Utils.Entity.Snapshots.Auth.User;
+                date: Date;
+              }[];
+              is_new: boolean;
+              translations: IItemTranslation[];
+            }
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,29 @@
+declare module Levelup {
+  namespace CMS {
+    namespace V1 {
+      namespace Content {
+        /**
+         * SubDomain Translation
+         */
+        export namespace Translation {
+          /**
+           * @description Service Entity
+           */
+          export namespace Entity {
+            export interface Namespace
+              extends Utils.Entity.General.ICreatable,
+                Utils.Entity.General.IHasSearchMeta {
+              _id: Utils.Common.ID;
+              project: Utils.Common.ID; // Project._id
+              name: string;
+              description: string;
+              settings: {
+                can_delete_translation_items: boolean;
+              };
+            }
+          }
+        }
+      }
+    }
+  }
+}