@maioradv/cms-basic-lib 1.0.0

package/dist/productAttributes/values.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const model_1 = require("../model");
+const graphql_1 = require("./graphql");
+class ProductAttributeValues extends model_1.ApiModule {
+    update(id, data) {
+        return this._call('patch', `/product-attribute-values/${id}`, data);
+    }
+    remove(id) {
+        return this._call('delete', `/product-attribute-values/${id}`);
+    }
+    list(args = {}) {
+        return this._graphql(graphql_1.ProductAttributeValuesResolvers.query.productAttributeValues, args);
+    }
+    removeMany(id) {
+        return this._graphql(graphql_1.ProductAttributeValuesResolvers.mutation.removeProductAttributeValues, {
+            id
+        });
+    }
+}
+exports.default = ProductAttributeValues;

package/dist/products/graphql.d.ts

@@ -0,0 +1,4 @@
+import { PaginatedGQLQueryDto } from "../core/dto/pagination";
+import { Resolvers } from "../core/types/resolver";
+export declare const ProductsResolvers: Resolvers<['products'], ['removeProducts']>;
+export type QueryProductGQLDto = PaginatedGQLQueryDto;

package/dist/products/graphql.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProductsResolvers = void 0;
+exports.ProductsResolvers = {
+    query: {
+        products: {
+            name: 'products',
+            query: `query ProductList($limit: Int, $after: Int, $before: Int){
+        products(limit: $limit, after: $after, before: $before){
+          edges {
+            node {
+              id
+            }
+            cursor
+          }
+          nodes {
+            id
+            slug
+            title
+            subtitle
+            description
+            tags
+            translations {
+              key
+              locale
+              value
+            }
+            metafields {
+              key 
+              value
+            }
+            published
+            createdAt
+            updatedAt
+          }
+          meta {
+            startCursor
+            endCursor
+            hasNextPage
+            hasPreviousPage
+          }
+        }
+      }`,
+        },
+    },
+    mutation: {
+        removeProducts: {
+            name: 'removeProducts',
+            query: `mutation ProductDelete($id: [Int!]!){
+        removeProducts(id: $id) {
+          count
+        }
+      }`,
+        },
+    }
+};

package/dist/products/index.d.ts

@@ -0,0 +1,26 @@
+import { PaginatedDto, PaginatedGQL } from "../core/dto/pagination";
+import { RemoveGQL } from "../core/model/remove-gql.response";
+import { Image } from "../images/types";
+import { RestApiModuleI, ApiModule, GraphApiModuleI } from "../model";
+import { CreateCollectionOnProductDto, CreateProductAttributeValueProductDto, CreateProductDto, CreateProductImageDto, CreateProductVariantDto, FindAllProductDto, FindOneProductDto, Product, ProductAttributeValueProduct, ProductCollection, ProductImage, ProductVariant, QueryProductDto, UpdateProductDto, UpdateProductImageDto } from "../products/types";
+import { WithRelation } from "../types";
+import { QueryProductGQLDto } from "./graphql";
+export default class Products extends ApiModule implements RestApiModuleI, GraphApiModuleI {
+    create(args: CreateProductDto): Promise<Product>;
+    findAll(args?: QueryProductDto): Promise<PaginatedDto<FindAllProductDto>>;
+    findOne(id: number): Promise<FindOneProductDto>;
+    update(id: number, data: UpdateProductDto): Promise<Product>;
+    remove(id: number): Promise<Product>;
+    list(args?: QueryProductGQLDto): Promise<PaginatedGQL<Product>>;
+    removeMany(id: number | number[]): Promise<RemoveGQL>;
+    createImage(productId: number, args: CreateProductImageDto): Promise<ProductImage>;
+    findAllImages(productId: number): Promise<WithRelation<ProductImage, 'Image', Image>[]>;
+    updateImage(productId: number, imageId: number, data: UpdateProductImageDto): Promise<ProductImage>;
+    removeImage(productId: number, imageId: number): Promise<ProductImage>;
+    linkCollection(productId: number, args: CreateCollectionOnProductDto): Promise<ProductCollection>;
+    unlinkCollection(productId: number, collectionId: number): Promise<ProductCollection>;
+    createVariant(productId: number, args: CreateProductVariantDto): Promise<ProductVariant>;
+    findAllVariants(productId: number): Promise<ProductVariant[]>;
+    linkAttributeValue(productId: number, args: CreateProductAttributeValueProductDto): Promise<ProductAttributeValueProduct>;
+    unlinkAttributeValue(productId: number, attributeValueId: number): Promise<ProductAttributeValueProduct>;
+}

package/dist/products/index.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const queryParams_1 = require("../core/utils/queryParams");
+const model_1 = require("../model");
+const graphql_1 = require("./graphql");
+class Products extends model_1.ApiModule {
+    create(args) {
+        return this._call('post', '/products', args);
+    }
+    findAll(args = {}) {
+        return this._call('get', '/products', (0, queryParams_1.queryParams)(args));
+    }
+    findOne(id) {
+        return this._call('get', `/products/${id}`);
+    }
+    update(id, data) {
+        return this._call('patch', `/products/${id}`, data);
+    }
+    remove(id) {
+        return this._call('delete', `/products/${id}`);
+    }
+    list(args = {}) {
+        return this._graphql(graphql_1.ProductsResolvers.query.products, args);
+    }
+    removeMany(id) {
+        return this._graphql(graphql_1.ProductsResolvers.mutation.removeProducts, {
+            id
+        });
+    }
+    createImage(productId, args) {
+        return this._call('post', `/products/${productId}/images`, args, {
+            headers: {
+                'Content-Type': 'multipart/form-data'
+            }
+        });
+    }
+    findAllImages(productId) {
+        return this._call('get', `/products/${productId}/images`);
+    }
+    updateImage(productId, imageId, data) {
+        return this._call('patch', `/products/${productId}/images/${imageId}`, data);
+    }
+    removeImage(productId, imageId) {
+        return this._call('delete', `/products/${productId}/images/${imageId}`);
+    }
+    linkCollection(productId, args) {
+        return this._call('post', `/products/${productId}/collections`, args);
+    }
+    unlinkCollection(productId, collectionId) {
+        return this._call('delete', `/products/${productId}/collections/${collectionId}`);
+    }
+    createVariant(productId, args) {
+        return this._call('post', `/products/${productId}/variants`, args);
+    }
+    findAllVariants(productId) {
+        return this._call('get', `/products/${productId}/variants`);
+    }
+    linkAttributeValue(productId, args) {
+        return this._call('post', `/products/${productId}/attribute-values`, args);
+    }
+    unlinkAttributeValue(productId, attributeValueId) {
+        return this._call('delete', `/products/${productId}/attribute-values/${attributeValueId}`);
+    }
+}
+exports.default = Products;

package/dist/products/types.d.ts

@@ -0,0 +1,82 @@
+import { BooleanClause, NumberClause, StringClause, WhereClausesDto } from "../core/dto/clauses";
+import { Sorting, SortingParamsDto } from "../core/dto/sorting";
+import { QueryParamsDto } from "../core/utils/queryParams";
+import { CreateImageDto, Image } from "../images/types";
+import { ProductAttributeValue } from "../productAttributes/types";
+import { Metafield, OmitRequire, Translation, WithRelation, WithRelations } from "../types";
+export type Product = {
+    id: number;
+    slug: string;
+    title: string;
+    subtitle: string | null;
+    description: string | null;
+    tags: string[];
+    translations: Translation[];
+    metafields: Metafield[];
+    published: boolean;
+    createdAt: Date;
+    updatedAt: Date;
+};
+export type ProductVariant = {
+    id: number;
+    description: string | null;
+    translations: Translation[];
+    price: number | null;
+    fullPrice: number | null;
+    productId: number;
+    published: boolean;
+    createdAt: Date;
+    updatedAt: Date;
+};
+export type ProductCollection = {
+    productId: number;
+    collectionId: number;
+    position: number | null;
+    createdAt: Date;
+    updatedAt: Date;
+};
+export type ProductImage = {
+    productId: number;
+    imageId: number;
+    locale: string | null;
+    position: number | null;
+    createdAt: Date;
+    updatedAt: Date;
+};
+export type ProductAttributeValueProduct = {
+    productId: number;
+    productAttributeValueId: number;
+    position: number | null;
+    createdAt: Date;
+    updatedAt: Date;
+};
+export type CreateProductCollectionDto = OmitRequire<ProductCollection, 'createdAt' | 'updatedAt', 'collectionId' | 'productId'>;
+export type CreateProductDto = OmitRequire<Product, 'id' | 'createdAt' | 'updatedAt' | 'slug', 'title'> & {
+    attributes?: number[];
+    variants?: CreateProductVariantDto[];
+};
+export type UpdateProductDto = Partial<Omit<CreateProductDto, 'variants' | 'attributes'>>;
+export type CreateProductImageDto = OmitRequire<ProductImage, 'productId' | 'createdAt' | 'updatedAt' | 'imageId'> & CreateImageDto;
+export type UpdateProductImageDto = Omit<CreateProductImageDto, 'file'>;
+export type CreateProductVariantDto = OmitRequire<ProductVariant, 'id' | 'createdAt' | 'updatedAt' | 'productId'>;
+export type UpdateProductVariantDto = Partial<CreateProductVariantDto>;
+export type CreateCollectionOnProductDto = Omit<CreateProductCollectionDto, 'productId'>;
+export type CreateProductAttributeValueProductDto = OmitRequire<ProductAttributeValueProduct, 'productId' | 'createdAt' | 'updatedAt' | 'position'>;
+export type FindAllProductDto = WithRelation<Product, 'ProductImage', WithRelation<ProductImage, 'Image', Image>[]>;
+export type FindOneProductDto = WithRelations<Product, {
+    attributes: WithRelation<ProductAttributeValueProduct, 'ProductAttributeValue', ProductAttributeValue>[];
+    ProductVariant: ProductVariant[];
+}>;
+export type SortingProductDto = SortingParamsDto<{
+    title?: Sorting;
+    published?: Sorting;
+}>;
+export type ClausesProductDto = WhereClausesDto<{
+    title?: StringClause;
+    subtitle?: StringClause;
+    description?: StringClause;
+    collectionId?: NumberClause;
+    productAttributeValueId?: NumberClause;
+    published?: BooleanClause;
+}>;
+export type QueryProductDto = QueryParamsDto<SortingProductDto, ClausesProductDto>;

package/dist/products/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/products/variants.d.ts

@@ -0,0 +1,6 @@
+import { ApiModule } from "../model";
+import { ProductVariant, UpdateProductVariantDto } from "../products/types";
+export default class ProductVariants extends ApiModule {
+    update(id: number, data: UpdateProductVariantDto): Promise<ProductVariant>;
+    remove(id: number): Promise<ProductVariant>;
+}

package/dist/products/variants.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const model_1 = require("../model");
+class ProductVariants extends model_1.ApiModule {
+    update(id, data) {
+        return this._call('patch', `/product-variants/${id}`, data);
+    }
+    remove(id) {
+        return this._call('delete', `/product-variants/${id}`);
+    }
+}
+exports.default = ProductVariants;

package/dist/roles/graphql.d.ts

@@ -0,0 +1,4 @@
+import { PaginatedGQLQueryDto } from "../core/dto/pagination";
+import { Resolvers } from "../core/types/resolver";
+export declare const RolesResolvers: Resolvers<['roles'], ['removeRoles']>;
+export type QueryRoleGQLDto = PaginatedGQLQueryDto;

package/dist/roles/graphql.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RolesResolvers = void 0;
+exports.RolesResolvers = {
+    query: {
+        roles: {
+            name: 'roles',
+            query: `query RoleList($limit: Int, $after: Int, $before: Int){
+        roles(limit: $limit, after: $after, before: $before){
+          edges {
+            node {
+              id
+            }
+            cursor
+          }
+          nodes {
+            id
+            name
+            description
+            permissions
+            readonly
+            translations {
+              key
+              locale
+              value
+            }
+            createdAt
+            updatedAt
+          }
+          meta {
+            startCursor
+            endCursor
+            hasNextPage
+            hasPreviousPage
+          }
+        }
+      }`,
+        },
+    },
+    mutation: {
+        removeRoles: {
+            name: 'removeRoles',
+            query: `mutation RoleDelete($id: [Int!]!){
+        removeRoles(id: $id) {
+          count
+        }
+      }`,
+        },
+    }
+};

package/dist/roles/index.d.ts

@@ -0,0 +1,14 @@
+import { PaginatedDto, PaginatedGQL } from "../core/dto/pagination";
+import { RemoveGQL } from "../core/model/remove-gql.response";
+import { RestApiModuleI, ApiModule, GraphApiModuleI } from "../model";
+import { QueryRoleGQLDto } from "./graphql";
+import { CreateRoleDto, QueryRoleDto, Role, UpdateRoleDto } from "./types";
+export default class Roles extends ApiModule implements RestApiModuleI, GraphApiModuleI {
+    create(args: CreateRoleDto): Promise<Role>;
+    findAll(args?: QueryRoleDto): Promise<PaginatedDto<Role>>;
+    findOne(id: number): Promise<Role>;
+    update(id: number, data: UpdateRoleDto): Promise<Role>;
+    remove(id: number): Promise<Role>;
+    list(args?: QueryRoleGQLDto): Promise<PaginatedGQL<Role>>;
+    removeMany(id: number | number[]): Promise<RemoveGQL>;
+}

package/dist/roles/index.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const queryParams_1 = require("../core/utils/queryParams");
+const model_1 = require("../model");
+const graphql_1 = require("./graphql");
+class Roles extends model_1.ApiModule {
+    create(args) {
+        return this._call('post', '/roles', args);
+    }
+    findAll(args = {}) {
+        return this._call('get', '/roles', (0, queryParams_1.queryParams)(args));
+    }
+    findOne(id) {
+        return this._call('get', `/roles/${id}`);
+    }
+    update(id, data) {
+        return this._call('patch', `/roles/${id}`, data);
+    }
+    remove(id) {
+        return this._call('delete', `/roles/${id}`);
+    }
+    list(args = {}) {
+        return this._graphql(graphql_1.RolesResolvers.query.roles, args);
+    }
+    removeMany(id) {
+        return this._graphql(graphql_1.RolesResolvers.mutation.removeRoles, {
+            id
+        });
+    }
+}
+exports.default = Roles;

package/dist/roles/types.d.ts

@@ -0,0 +1,25 @@
+import { Permission } from "../auth/types";
+import { StringClause, WhereClausesDto } from "../core/dto/clauses";
+import { Sorting, SortingParamsDto } from "../core/dto/sorting";
+import { QueryParamsDto } from "../core/utils/queryParams";
+import { OmitRequire, Translation } from "../types";
+export type Role = {
+    id: number;
+    name: string;
+    description: string | null;
+    permissions: Permission[];
+    readOnly: boolean;
+    translations: Translation[];
+    createdAt: Date;
+    updatedAt: Date;
+};
+export type CreateRoleDto = OmitRequire<Role, 'id' | 'createdAt' | 'updatedAt' | 'readOnly', 'name' | 'permissions'>;
+export type UpdateRoleDto = Partial<CreateRoleDto>;
+export type SortingRoleDto = SortingParamsDto<{
+    name?: Sorting;
+}>;
+export type ClausesRoleDto = WhereClausesDto<{
+    name?: StringClause;
+    description?: StringClause;
+}>;
+export type QueryRoleDto = QueryParamsDto<SortingRoleDto, ClausesRoleDto>;

package/dist/roles/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types.d.ts

@@ -0,0 +1,30 @@
+export declare enum ApiVersion {
+    July24 = "2024-07",
+    Unstable = "unstable"
+}
+export declare const LATEST_API_VERSION = ApiVersion.July24;
+export declare const SUPPORTED_API_VERSIONS: ApiVersion[];
+export declare enum ApiHeader {
+    Authorization = "Authorization",
+    ApiVersion = "X-Api-Version",
+    ApiCacheControl = "X-Api-Cache-Control"
+}
+export type Metafield = {
+    key: string;
+    value: string;
+};
+export type Translation = {
+    key: string;
+    value: string;
+    locale: string;
+};
+export type WithRelation<T, R extends string, RType> = T & {
+    [key in R]: RType;
+};
+export type WithRelations<T, R extends object> = T & R;
+export type WithRequired<T, K extends keyof T> = T & {
+    [P in K]-?: T[P];
+};
+export type OmitRequire<T, O extends keyof T = null, R extends keyof T = null> = Partial<Omit<T, O>> & {
+    [P in R]-?: T[P];
+};

package/dist/types.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiHeader = exports.SUPPORTED_API_VERSIONS = exports.LATEST_API_VERSION = exports.ApiVersion = void 0;
+var ApiVersion;
+(function (ApiVersion) {
+    ApiVersion["July24"] = "2024-07";
+    ApiVersion["Unstable"] = "unstable";
+})(ApiVersion || (exports.ApiVersion = ApiVersion = {}));
+exports.LATEST_API_VERSION = ApiVersion.July24;
+exports.SUPPORTED_API_VERSIONS = [
+    exports.LATEST_API_VERSION,
+    ApiVersion.Unstable
+];
+var ApiHeader;
+(function (ApiHeader) {
+    ApiHeader["Authorization"] = "Authorization";
+    ApiHeader["ApiVersion"] = "X-Api-Version";
+    ApiHeader["ApiCacheControl"] = "X-Api-Cache-Control";
+})(ApiHeader || (exports.ApiHeader = ApiHeader = {}));

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@maioradv/cms-basic-lib",
+  "version": "1.0.0",
+  "description": "JS lib for Maior CMS Basic Api",
+  "repository": "https://github.com/maioradv/cms-basic-lib.git",
+  "author": "Maior ADV Srl",
+  "license": "MIT",
+  "private": false,
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "/dist"
+  ],
+  "scripts": {
+    "example": "ts-node example/test.ts",
+    "build": "tsc"
+  },
+  "dependencies": {
+    "axios": "^1.7.2"
+  },
+  "devDependencies": {
+    "@types/node": "^20.14.9",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.5.3"
+  },
+  "keywords": [
+    "typescript",
+    "maior"
+  ]
+}