@phygitallabs/phygital-consent 1.0.0

package/src/types/common.ts

@@ -0,0 +1,26 @@
+export enum MediaType {
+  IMAGE = "image",
+  VIDEO = "video",
+}
+
+export type DateTimeNumber = number;
+
+export interface Media {
+  url: string;
+  type: MediaType | string;
+  thumbnail_url?: string;
+}
+
+export enum EntityStatus {
+  ACTIVE = "Active",
+  INACTIVE = "Inactive",
+}
+
+export interface CommonModel {
+  id: string;
+  status: EntityStatus;
+  created_at: DateTimeNumber;
+  updated_at: DateTimeNumber;
+  created_by?: string;
+  updated_by?: string;
+}

package/src/types/consent.ts

@@ -0,0 +1,103 @@
+/**
+ * Types aligned with Phygital Consent API (NCS) Swagger 2.0
+ */
+
+export type ConsentStatus = "ACCEPTED" | "REJECTED";
+
+export type PolicyType = "ACCOUNT_REGISTER" | "COOKIE_PREFERENCE";
+
+export type PolicyStatus = "ACTIVE" | "INACTIVE";
+
+/** Document within a policy (e.g. Terms of Service, Privacy Policy) */
+export interface PolicyDocument {
+  name?: string;
+  version?: string;
+  effective_date?: string;
+  last_updated?: string;
+  meta_data?: Record<string, unknown>;
+}
+
+export interface PolicyPreference {
+  id?: string;
+  name?: string;
+  description?: string;
+  is_mandatory?: boolean;
+}
+
+export interface PolicyDetailDTO {
+  id?: string;
+  name?: string;
+  description?: string;
+  type?: PolicyType;
+  documents?: PolicyDocument[];
+  preferences?: PolicyPreference[];
+  version?: string;
+  meta_data?: Record<string, unknown>;
+  created_at?: string;
+  updated_at?: string;
+  status?: PolicyStatus;
+}
+
+export interface ConsentLogDetailDTO {
+  id?: string;
+  user_id?: string;
+  device_uid?: string;
+  policy_id?: string;
+  policy?: PolicyDetailDTO;
+  selected_preferences?: string[];
+  status?: ConsentStatus;
+  created_at?: string;
+}
+
+/** Create user consent (account register) – body for POST /consent/v1/user-id */
+export interface CreateUserConsentUpsertDTO {
+  user_id?: string;
+  device_id?: string;
+  selected_preferences?: string[];
+  status: ConsentStatus;
+}
+
+/** Create device cookie consent – body for POST /consent/v1/cookies/device-id */
+export interface CreateDeviceCookieConsentUpsertDTO {
+  device_id: string;
+  selected_preferences?: string[];
+  status: ConsentStatus;
+}
+
+// --- Request params ---
+
+export interface GetManyConsentParams {
+  /** Filter by policy type */
+  type?: PolicyType;
+}
+
+export interface GetConsentByIdParams {
+  id: string;
+}
+
+export interface GetLatestConsentByUserIdParams {
+  user_id: string;
+}
+
+export interface GetLatestCookieConsentByDeviceIdParams {
+  device_id: string;
+}
+
+// --- Response types (API returns single DTO or array) ---
+
+export type GetManyConsentResponse = ConsentLogDetailDTO[];
+
+export type GetConsentByIdResponse = ConsentLogDetailDTO;
+
+export type GetLatestConsentByUserIdResponse = ConsentLogDetailDTO;
+
+export type GetLatestCookieConsentByDeviceIdResponse = ConsentLogDetailDTO;
+
+export type CreateUserConsentResponse = ConsentLogDetailDTO;
+
+export type CreateDeviceCookieConsentResponse = ConsentLogDetailDTO;
+
+export interface HealthResponse {
+  status?: string;
+  [key: string]: unknown;
+}

package/src/types/index.ts

@@ -0,0 +1,3 @@
+export * from "./common";
+export * from "./pagination";
+export * from "./consent";

package/src/types/pagination.ts

@@ -0,0 +1,30 @@
+export interface PaginationRequest {
+  page?: number;
+  limit?: number;
+  total?: number;
+  next_cursor?: string;
+  order_by?: string;
+  order_direction?: "desc" | "asc";
+  search?: string;
+  cursor?: string;
+  start_time?: number;
+  end_time?: number;
+}
+
+export interface PaginationResponse {
+  order_by: string;
+  order_direction: string;
+  limit: number;
+  page: number;
+  total: number;
+}
+
+export interface GetManyResponse<T> {
+  data: T[];
+  pagination: PaginationResponse;
+}
+
+export interface GetOneResponse<T> {
+  data: T;
+  error: string;
+}

package/tsconfig.json

@@ -0,0 +1,34 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "useDefineForClassFields": true,
+    "lib": ["ES2021", "DOM", "DOM.Iterable"],
+    "module": "ESNext",
+    "skipLibCheck": true,
+    "allowJs": false,
+    /* Bundler mode */
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": true,
+    "jsx": "react-jsx",
+    "baseUrl": ".",
+    "paths": {
+      "@/hooks/*": ["src/hooks/*"],
+      "react": ["./node_modules/@types/react"]
+    },
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true,
+    "outDir": "./dist",
+    "rootDir": ".",
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true
+  },
+  "exclude": ["node_modules", "dist"],
+  "include": ["."]
+}

package/tsup.config.ts

@@ -0,0 +1,20 @@
+/* eslint-disable import/no-default-export */
+/* eslint-disable import/no-extraneous-dependencies */
+import type { Options } from "tsup";
+import { defineConfig } from "tsup";
+
+export default defineConfig((options: Options) => ({
+  entry: ["index.ts"],
+  banner: {
+    js: "'use client'",
+  },
+  format: ["esm", "cjs"],
+  outExtension: ({ format }) => ({ js: format === "cjs" ? ".cjs" : ".js" }),
+  dts: true,
+  clean: true,
+  external: ["react", "axios", "@tanstack/react-query", "@tanstack/react-query-devtools"],
+  sourcemap: true,
+  minify: true,
+  injectStyle: true,
+  ...options,
+}));