target-supabase-sdk 0.1.0 → 0.1.2

package/src/core.interface.ts

@@ -1,74 +1,74 @@
-import { PostgrestError } from "@supabase/supabase-js";
-
-export interface Target {
-  id: string;
-  category: string;
-  name: string;
-  value: string;
-  tagList: string[];
-  extra?: string;
-  details?: unknown;
-  created_at: string;
-}
-
-export enum StatusCode {
-  SUCCESS = 200,
-  ERROR = 400,
-}
-
-export interface SupabaseResponse<T = unknown> {
-  status_code: StatusCode;
-  success: boolean;
-  message?: string;
-  data?: T;
-  error?: {
-    message: string;
-    code?: string;
-  };
-}
-
-export const createResponse = {
-  success<T>(data?: T, message?: string): SupabaseResponse<T> {
-    return {
-      status_code: StatusCode.SUCCESS,
-      success: true,
-      message,
-      data,
-    };
-  },
-
-  error(
-    message: string | { key: string; error: PostgrestError } | { key: string; error: string },
-    statusCode?: StatusCode,
-    code?: string
-  ): SupabaseResponse {
-    if (typeof message === "string") {
-      return {
-        status_code: statusCode ?? StatusCode.ERROR,
-        success: false,
-        error: {
-          message,
-          code,
-        },
-      };
-    }
-    if (typeof message?.error === "string") {
-      return {
-        status_code: statusCode ?? StatusCode.ERROR,
-        success: false,
-        error: {
-          message: `Error from ${message.key}: ${message.error}`,
-          code,
-        },
-      };
-    }
-    return {
-      status_code: statusCode ?? StatusCode.ERROR,
-      success: false,
-      error: {
-        message: `Error from ${message.key}: ${message?.error?.message}`,
-        code,
-      },
-    };
-  },
-};
+import { PostgrestError } from "@supabase/supabase-js";
+
+export interface Target {
+  id: string;
+  category: string;
+  name: string;
+  value: string;
+  tagList: string[];
+  extra?: string;
+  details?: unknown;
+  created_at: string;
+}
+
+export enum StatusCode {
+  SUCCESS = 200,
+  ERROR = 400,
+}
+
+export interface SupabaseResponse<T = unknown> {
+  status_code: StatusCode;
+  success: boolean;
+  message?: string;
+  data?: T;
+  error?: {
+    message: string;
+    code?: string;
+  };
+}
+
+export const createResponse = {
+  success<T>(data?: T, message?: string): SupabaseResponse<T> {
+    return {
+      status_code: StatusCode.SUCCESS,
+      success: true,
+      message,
+      data,
+    };
+  },
+
+  error(
+    message: string | { key: string; error: PostgrestError } | { key: string; error: string },
+    statusCode?: StatusCode,
+    code?: string
+  ): SupabaseResponse {
+    if (typeof message === "string") {
+      return {
+        status_code: statusCode ?? StatusCode.ERROR,
+        success: false,
+        error: {
+          message,
+          code,
+        },
+      };
+    }
+    if (typeof message?.error === "string") {
+      return {
+        status_code: statusCode ?? StatusCode.ERROR,
+        success: false,
+        error: {
+          message: `Error from ${message.key}: ${message.error}`,
+          code,
+        },
+      };
+    }
+    return {
+      status_code: statusCode ?? StatusCode.ERROR,
+      success: false,
+      error: {
+        message: `Error from ${message.key}: ${message?.error?.message}`,
+        code,
+      },
+    };
+  },
+};

package/src/core.utils.ts

@@ -1,98 +1,98 @@
-import { pick, pickBy } from "lodash-es";
-
-/** True when running in a development build (Vite or Node). Defaults to false for safety. */
-export function isDevEnvironment(): boolean {
-  if (typeof import.meta !== "undefined" && "env" in import.meta) {
-    const env = (import.meta as ImportMeta & { env?: { DEV?: boolean; MODE?: string } }).env;
-    if (env?.DEV === true || env?.MODE === "development") return true;
-    if (env?.DEV === false || env?.MODE === "production") return false;
-  }
-  if (typeof process !== "undefined" && process.env?.NODE_ENV) {
-    return process.env.NODE_ENV !== "production";
-  }
-  return false;
-}
-
-export function logDev(...args: unknown[]): void {
-  if (isDevEnvironment()) {
-    console.log(...args);
-  }
-}
-
-export function logDevGroup(label: string, fn: () => void): void {
-  if (!isDevEnvironment()) return;
-  console.group(label);
-  try {
-    fn();
-  } finally {
-    console.groupEnd();
-  }
-}
-
-/** Log internal details, then throw a sanitized error safe to expose to callers. */
-export function handleSupabaseError(context: string, error: unknown, publicMessage?: string): never {
-  console.error(`[${context}] failed:`, error);
-  throw new Error(publicMessage ?? `[${context}] Operation failed`);
-}
-
-/** Raw payload -> Available data */
-export abstract class BaseValidator<T extends object> {
-  protected requiredFields: (keyof T)[] = [];
-  protected optionalFields: (keyof T)[] = [];
-  protected ignoredFields: (keyof T)[] = [];
-  protected customValidators: ((val: T) => true | string)[] = [];
-
-  /** @deprecated -> addCustomValidator */
-  addValidator(validator: (val: T) => true | string) {
-    this.customValidators.push(validator);
-    return this;
-  }
-
-  addCustomValidator(validator: (val: T) => true | string) {
-    this.customValidators.push(validator);
-    return this;
-  }
-
-  protected validateField(field: keyof T, value: unknown): boolean {
-    // TODO now only empty check, later should add type checks
-    return value != null;
-  }
-
-  validate = (val: T): T => {
-    const errors: string[] = [];
-
-    // Step 1: Check required fields
-    this.requiredFields.forEach((field) => {
-      if (!this.validateField(field, val[field])) {
-        errors.push(`Missing required field: ${String(field)}`);
-      }
-    });
-
-    // Step 2: Run custom validators
-    this.customValidators.forEach((validator) => {
-      const result = validator(val);
-      if (result !== true) {
-        errors.push(`Custom validation failed ${result}`);
-      }
-    });
-
-    if (errors.length > 0) {
-      const errorCount = errors.length;
-      const errorList = errors.map((error, index) => `  ${index + 1}. ${error}`).join("\n");
-
-      throw new Error(
-        `[${this.constructor.name}] Validation failed (${errorCount} error${errorCount > 1 ? "s" : ""}):\n${errorList}`
-      );
-    }
-
-    // Step 3: Pick required and optional fields
-    const required = pick(val, this.requiredFields);
-    const optional = pickBy(val, (value, key) => {
-      const typedKey = key as keyof T;
-      return this.optionalFields.includes(typedKey) && value != null;
-    }) as Partial<T>;
-    // TODO ignoredFields
-
-    return { ...required, ...optional } as T;
-  };
-}
+import { pick, pickBy } from "lodash-es";
+
+/** True when running in a development build (Vite or Node). Defaults to false for safety. */
+export function isDevEnvironment(): boolean {
+  if (typeof import.meta !== "undefined" && "env" in import.meta) {
+    const env = (import.meta as ImportMeta & { env?: { DEV?: boolean; MODE?: string } }).env;
+    if (env?.DEV === true || env?.MODE === "development") return true;
+    if (env?.DEV === false || env?.MODE === "production") return false;
+  }
+  if (typeof process !== "undefined" && process.env?.NODE_ENV) {
+    return process.env.NODE_ENV !== "production";
+  }
+  return false;
+}
+
+export function logDev(...args: unknown[]): void {
+  if (isDevEnvironment()) {
+    console.log(...args);
+  }
+}
+
+export function logDevGroup(label: string, fn: () => void): void {
+  if (!isDevEnvironment()) return;
+  console.group(label);
+  try {
+    fn();
+  } finally {
+    console.groupEnd();
+  }
+}
+
+/** Log internal details, then throw a sanitized error safe to expose to callers. */
+export function handleSupabaseError(context: string, error: unknown, publicMessage?: string): never {
+  console.error(`[${context}] failed:`, error);
+  throw new Error(publicMessage ?? `[${context}] Operation failed`);
+}
+
+/** Raw payload -> Available data */
+export abstract class BaseValidator<T extends object> {
+  protected requiredFields: (keyof T)[] = [];
+  protected optionalFields: (keyof T)[] = [];
+  protected ignoredFields: (keyof T)[] = [];
+  protected customValidators: ((val: T) => true | string)[] = [];
+
+  /** @deprecated -> addCustomValidator */
+  addValidator(validator: (val: T) => true | string) {
+    this.customValidators.push(validator);
+    return this;
+  }
+
+  addCustomValidator(validator: (val: T) => true | string) {
+    this.customValidators.push(validator);
+    return this;
+  }
+
+  protected validateField(field: keyof T, value: unknown): boolean {
+    // TODO now only empty check, later should add type checks
+    return value != null;
+  }
+
+  validate = (val: T): T => {
+    const errors: string[] = [];
+
+    // Step 1: Check required fields
+    this.requiredFields.forEach((field) => {
+      if (!this.validateField(field, val[field])) {
+        errors.push(`Missing required field: ${String(field)}`);
+      }
+    });
+
+    // Step 2: Run custom validators
+    this.customValidators.forEach((validator) => {
+      const result = validator(val);
+      if (result !== true) {
+        errors.push(`Custom validation failed ${result}`);
+      }
+    });
+
+    if (errors.length > 0) {
+      const errorCount = errors.length;
+      const errorList = errors.map((error, index) => `  ${index + 1}. ${error}`).join("\n");
+
+      throw new Error(
+        `[${this.constructor.name}] Validation failed (${errorCount} error${errorCount > 1 ? "s" : ""}):\n${errorList}`
+      );
+    }
+
+    // Step 3: Pick required and optional fields
+    const required = pick(val, this.requiredFields);
+    const optional = pickBy(val, (value, key) => {
+      const typedKey = key as keyof T;
+      return this.optionalFields.includes(typedKey) && value != null;
+    }) as Partial<T>;
+    // TODO ignoredFields
+
+    return { ...required, ...optional } as T;
+  };
+}

package/src/feed/feed.interface.ts

@@ -1,33 +1,33 @@
-import { Target } from "../core.interface";
-
-export interface Feed extends Target {
-  category: CategoryFeed;
-  details: FeedDetails;
-}
-
-export enum CategoryFeed {
-  FEED = "feed",
-  DOC = "doc",
-}
-
-export interface FeedDetails {
-  manifestVersion: number;
-  list: FeedItem[];
-}
-
-export enum FeedItemType {
-  /** Plain Target */
-  TEXT = "TEXT",
-  /** Parcel */
-  IMAGE = "IMAGE",
-  /** Parcel */
-  VIDEO = "VIDEO",
-  /** TODO Review */
-  // REVIEW = "REVIEW",
-}
-
-export interface FeedItem {
-  index: number;
-  type: FeedItemType;
-  refTargetId: string;
-}
+import { Target } from "../core.interface";
+
+export interface Feed extends Target {
+  category: CategoryFeed;
+  details: FeedDetails;
+}
+
+export enum CategoryFeed {
+  FEED = "feed",
+  DOC = "doc",
+}
+
+export interface FeedDetails {
+  manifestVersion: number;
+  list: FeedItem[];
+}
+
+export enum FeedItemType {
+  /** Plain Target */
+  TEXT = "TEXT",
+  /** Parcel */
+  IMAGE = "IMAGE",
+  /** Parcel */
+  VIDEO = "VIDEO",
+  /** TODO Review */
+  // REVIEW = "REVIEW",
+}
+
+export interface FeedItem {
+  index: number;
+  type: FeedItemType;
+  refTargetId: string;
+}

package/src/file/file.api.ts

@@ -1,43 +1,43 @@
-import { createTarget } from "../core.api";
-import { BaseValidator } from "../core.utils";
-import { File, CategoryFile, FileDetails } from "./file.interface";
-
-export interface PostFileCreatePayload {
-  name: File["name"];
-  value: File["value"];
-  category: File["category"];
-  details: FileDetails;
-}
-
-export class PostFileValidator extends BaseValidator<PostFileCreatePayload> {
-  protected requiredFields: (keyof PostFileCreatePayload)[] = ["name", "value", "category", "details"];
-  protected optionalFields: (keyof PostFileCreatePayload)[] = [];
-
-  constructor() {
-    super();
-    // Add custom
-    this.addCustomValidator((val) => {
-      return true;
-    });
-  }
-}
-
-
-
-export const postFileCreate = async (payload: PostFileCreatePayload) => {
-  return createTarget<File, PostFileCreatePayload>({
-    payload: payload,
-    validator: PostFileValidator,
-    createFn: (validPayload) => {
-      const { name, value, category, details } = validPayload;
-
-      return {
-        name,
-        category,
-        value,
-        tagList: [],
-        details,
-      };
-    },
-  });
-};
+import { createTarget } from "../core.api";
+import { BaseValidator } from "../core.utils";
+import { File, CategoryFile, FileDetails } from "./file.interface";
+
+export interface PostFileCreatePayload {
+  name: File["name"];
+  value: File["value"];
+  category: File["category"];
+  details: FileDetails;
+}
+
+export class PostFileValidator extends BaseValidator<PostFileCreatePayload> {
+  protected requiredFields: (keyof PostFileCreatePayload)[] = ["name", "value", "category", "details"];
+  protected optionalFields: (keyof PostFileCreatePayload)[] = [];
+
+  constructor() {
+    super();
+    // Add custom
+    this.addCustomValidator((val) => {
+      return true;
+    });
+  }
+}
+
+
+
+export const postFileCreate = async (payload: PostFileCreatePayload) => {
+  return createTarget<File, PostFileCreatePayload>({
+    payload: payload,
+    validator: PostFileValidator,
+    createFn: (validPayload) => {
+      const { name, value, category, details } = validPayload;
+
+      return {
+        name,
+        category,
+        value,
+        tagList: [],
+        details,
+      };
+    },
+  });
+};

package/src/file/file.interface.ts

@@ -1,30 +1,30 @@
-import { Target } from "../core.interface";
-
-export enum CategoryFile {
-  VIDEO = "video",
-  IMAGE = "image",
-  TEXT = "text",
-}
-
-export interface File extends Target {
-  details: FileDetails;
-  category: CategoryFile;
-}
-
-export interface FileDetails {
-  manifestVersion: number;
-  /** "abc.1" 唯一键 */
-  value: string;
-  hash: string | null;
-  preview: FilePreview | null;
-  /** Quickly access the file */
-  url: string | null;
-  parcelId: string | null;
-  /** TODO 消費與改動歷史 */
-  // reviewList?: string[];
-};
-
-export interface FilePreview {
-  manifestVersion: number;
-  refTargetId: string;
+import { Target } from "../core.interface";
+
+export enum CategoryFile {
+  VIDEO = "video",
+  IMAGE = "image",
+  TEXT = "text",
+}
+
+export interface File extends Target {
+  details: FileDetails;
+  category: CategoryFile;
+}
+
+export interface FileDetails {
+  manifestVersion: number;
+  /** "abc.1" 唯一键 */
+  value: string;
+  hash: string | null;
+  preview: FilePreview | null;
+  /** Quickly access the file */
+  url: string | null;
+  parcelId: string | null;
+  /** TODO 消費與改動歷史 */
+  // reviewList?: string[];
+};
+
+export interface FilePreview {
+  manifestVersion: number;
+  refTargetId: string;
 };