@davidmashadow/ss-ecommerce-types 1.0.0

package/README.md

@@ -0,0 +1,74 @@
+# @your-org/shared-types
+
+Shared TypeScript types and empty constants for backend and frontend applications.
+
+## Installation
+
+```bash
+npm install @your-org/shared-types
+```
+
+## Usage
+
+```typescript
+import { 
+  User, 
+  EMPTY_USER, 
+  ApiResponse, 
+  createEmptyApiResponse 
+} from '@your-org/shared-types';
+
+// Use types
+const user: User = {
+  id: '123',
+  email: 'test@example.com',
+  firstName: 'John',
+  lastName: 'Doe',
+  createdAt: new Date(),
+  updatedAt: new Date(),
+};
+
+// Use empty constants for initialization
+const emptyUser = { ...EMPTY_USER };
+
+// Use generic API response
+const response: ApiResponse<User> = createEmptyApiResponse<User>();
+```
+
+## Development
+
+```bash
+# Install dependencies
+npm install
+
+# Build
+npm run build
+```
+
+## Publishing
+
+1. Update the package name in `package.json` (replace `@your-org` with your npm org/username)
+2. Login to npm: `npm login`
+3. Publish: `npm publish --access public`
+
+## Project Structure
+
+```
+src/
+├── index.ts              # Main entry point
+└── types/
+    ├── index.ts          # Types barrel export
+    ├── user.types.ts     # User related types & constants
+    └── api.types.ts      # API related types & constants
+```
+
+## Adding New Types
+
+1. Create a new file in `src/types/` (e.g., `product.types.ts`)
+2. Define your interfaces and empty constants
+3. Export from `src/types/index.ts`
+4. Run `npm run build` to compile
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Main entry point for shared-types package
+ *
+ * Usage:
+ * import { User, EMPTY_USER, ApiResponse } from '@your-org/shared-types';
+ */
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,cAAc,SAAS,CAAC"}

package/dist/index.js

@@ -0,0 +1,24 @@
+"use strict";
+/**
+ * Main entry point for shared-types package
+ *
+ * Usage:
+ * import { User, EMPTY_USER, ApiResponse } from '@your-org/shared-types';
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;;;;;;;;;;;AAEH,0CAAwB"}

package/dist/types/api.types.d.ts

@@ -0,0 +1,30 @@
+/**
+ * API related types and empty constants
+ */
+export interface ApiResponse<T> {
+    success: boolean;
+    data: T | null;
+    error: ApiError | null;
+    meta: ApiMeta;
+}
+export interface ApiError {
+    code: string;
+    message: string;
+    details: Record<string, unknown>;
+}
+export interface ApiMeta {
+    timestamp: string;
+    requestId: string;
+    pagination: Pagination | null;
+}
+export interface Pagination {
+    page: number;
+    limit: number;
+    total: number;
+    totalPages: number;
+}
+export declare const EMPTY_PAGINATION: Pagination;
+export declare const EMPTY_API_META: ApiMeta;
+export declare const EMPTY_API_ERROR: ApiError;
+export declare function createEmptyApiResponse<T>(): ApiResponse<T>;
+//# sourceMappingURL=api.types.d.ts.map

package/dist/types/api.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.types.d.ts","sourceRoot":"","sources":["../../src/types/api.types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,MAAM,WAAW,WAAW,CAAC,CAAC;IAC1B,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC;IACf,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAC;IACvB,IAAI,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,QAAQ;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,OAAO;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,UAAU,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,UAAU;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;CACtB;AAID,eAAO,MAAM,gBAAgB,EAAE,UAK9B,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,OAI5B,CAAC;AAEF,eAAO,MAAM,eAAe,EAAE,QAI7B,CAAC;AAEF,wBAAgB,sBAAsB,CAAC,CAAC,KAAK,WAAW,CAAC,CAAC,CAAC,CAO1D"}

package/dist/types/api.types.js

@@ -0,0 +1,33 @@
+"use strict";
+/**
+ * API related types and empty constants
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EMPTY_API_ERROR = exports.EMPTY_API_META = exports.EMPTY_PAGINATION = void 0;
+exports.createEmptyApiResponse = createEmptyApiResponse;
+// ============ EMPTY CONSTANTS ============
+exports.EMPTY_PAGINATION = {
+    page: 0,
+    limit: 0,
+    total: 0,
+    totalPages: 0,
+};
+exports.EMPTY_API_META = {
+    timestamp: '',
+    requestId: '',
+    pagination: null,
+};
+exports.EMPTY_API_ERROR = {
+    code: '',
+    message: '',
+    details: {},
+};
+function createEmptyApiResponse() {
+    return {
+        success: false,
+        data: null,
+        error: null,
+        meta: exports.EMPTY_API_META,
+    };
+}
+//# sourceMappingURL=api.types.js.map

package/dist/types/api.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.types.js","sourceRoot":"","sources":["../../src/types/api.types.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAmDH,wDAOC;AA5BD,4CAA4C;AAE/B,QAAA,gBAAgB,GAAe;IACxC,IAAI,EAAE,CAAC;IACP,KAAK,EAAE,CAAC;IACR,KAAK,EAAE,CAAC;IACR,UAAU,EAAE,CAAC;CAChB,CAAC;AAEW,QAAA,cAAc,GAAY;IACnC,SAAS,EAAE,EAAE;IACb,SAAS,EAAE,EAAE;IACb,UAAU,EAAE,IAAI;CACnB,CAAC;AAEW,QAAA,eAAe,GAAa;IACrC,IAAI,EAAE,EAAE;IACR,OAAO,EAAE,EAAE;IACX,OAAO,EAAE,EAAE;CACd,CAAC;AAEF,SAAgB,sBAAsB;IAClC,OAAO;QACH,OAAO,EAAE,KAAK;QACd,IAAI,EAAE,IAAI;QACV,KAAK,EAAE,IAAI;QACX,IAAI,EAAE,sBAAc;KACvB,CAAC;AACN,CAAC"}

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from './user.types';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC"}

package/dist/types/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./user.types"), exports);
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B"}

package/dist/types/product.types.d.ts

@@ -0,0 +1,5 @@
+export interface IStaticImage {
+    name: string;
+    image: string;
+}
+//# sourceMappingURL=product.types.d.ts.map

package/dist/types/product.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"product.types.d.ts","sourceRoot":"","sources":["../../src/types/product.types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,YAAY;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACjB"}

package/dist/types/product.types.js

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

package/dist/types/product.types.js.map

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

package/dist/types/traffic.types.d.ts

@@ -0,0 +1,13 @@
+export interface IIpDetails {
+    geographic?: {
+        ip: string;
+        isp: string;
+        country: string;
+        country_flag: string;
+        city: string;
+    };
+    localIp?: string | {
+        Ethernet: [string];
+    };
+}
+//# sourceMappingURL=traffic.types.d.ts.map

package/dist/types/traffic.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"traffic.types.d.ts","sourceRoot":"","sources":["../../src/types/traffic.types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,UAAU;IACvB,UAAU,CAAC,EAAE;QACT,EAAE,EAAE,MAAM,CAAC;QACX,GAAG,EAAE,MAAM,CAAC;QACZ,OAAO,EAAE,MAAM,CAAC;QAChB,YAAY,EAAE,MAAM,CAAC;QACrB,IAAI,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,OAAO,CAAC,EAAE,MAAM,GAAG;QAAE,QAAQ,EAAE,CAAC,MAAM,CAAC,CAAA;KAAE,CAAC;CAC7C"}

package/dist/types/traffic.types.js

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

package/dist/types/traffic.types.js.map

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

package/dist/types/user.types.d.ts

@@ -0,0 +1,20 @@
+import type { IStaticImage } from "./product.types";
+import type { IIpDetails } from "./traffic.types";
+export interface IUser {
+    _id: string;
+    name: string;
+    surname?: string;
+    email: string;
+    phoneNumber: string;
+    password: string;
+    profileImage: IStaticImage[];
+    role: ['ROLE_USER'] | ['ROLE_ADMIN'];
+    isActivated: boolean;
+    activationType: 'email' | 'phone';
+    activationKey?: string;
+    activationCode?: string;
+    details: IIpDetails;
+    createdAt: string;
+    updatedAt: string;
+}
+//# sourceMappingURL=user.types.d.ts.map

package/dist/types/user.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.types.d.ts","sourceRoot":"","sources":["../../src/types/user.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAElD,MAAM,WAAW,KAAK;IAClB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,YAAY,EAAE,CAAC;IAC7B,IAAI,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IACrC,WAAW,EAAE,OAAO,CAAC;IACrB,cAAc,EAAE,OAAO,GAAG,OAAO,CAAC;IAClC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,OAAO,EAAE,UAAU,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACrB"}

package/dist/types/user.types.js

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

package/dist/types/user.types.js.map

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

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@davidmashadow/ss-ecommerce-types",
+  "version": "1.0.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "Shared TypeScript types and empty constants for ss e-commerce backend and frontend",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "typescript": "^5.7.3"
+  }
+}