target-supabase-sdk 0.2.0 → 0.2.1

package/src/question-list/question-list.interface.ts

@@ -1,21 +0,0 @@
-import { Target } from "../core.interface";
-
-export interface Question {
-  ans: string;
-  reminder: string;
-}
-
-export type QuestionListDetails = {
-  /** Human readable name, should be same to Target.name */
-  name: string;
-  list: Question[];
-};
-
-export enum CategoryQuestionList {
-  QUESTION_LIST = "question-list",
-}
-
-export interface QuestionList extends Target {
-  category: CategoryQuestionList;
-  details: QuestionListDetails;
-}

package/src/review/review.api.ts

@@ -1,145 +0,0 @@
-import { cloneDeep } from "lodash-es";
-import { createTarget, getPossibleTarget, updateTargetDetails } from "../core.api";
-import { generateResponse } from "../core.interface";
-import { BaseValidator } from "../core.utils";
-import { CategoryReview, Review, ReviewDetails } from "./review.interface";
-
-class PatchUpsertReviewValidator extends BaseValidator<ReviewDetails> {
-  protected requiredFields: (keyof ReviewDetails)[] = ["reviewTargetId", "reviewDomain", "reviewResult"];
-  protected optionalFields: (keyof ReviewDetails)[] = [];
-  protected ignoredFields: (keyof ReviewDetails)[] = ["reviewCount", "lastUpdated"];
-
-  constructor() {
-    super();
-    // Add custom
-    this.addCustomValidator((val) => {
-      if (val.reviewResult == null || Object.values(val.reviewResult).some((v) => typeof v !== "number")) {
-        return "[Check reviewResult] reviewResult invalid";
-      }
-      return true;
-    });
-  }
-}
-
-export const patchUpsertReview = async (payload: ReviewDetails) => {
-  const validPayload = new PatchUpsertReviewValidator().validate(payload);
-  const { reviewTargetId, reviewDomain } = validPayload;
-
-  // Check redundancy
-  const { data: possibleReview } = await getPossibleTarget({
-    filterList: [
-      {
-        field: "category",
-        operator: "eq",
-        value: CategoryReview.REVIEW,
-      },
-      {
-        field: "details->>reviewTargetId",
-        operator: "eq",
-        value: reviewTargetId,
-      },
-      {
-        field: "details->>reviewDomain",
-        operator: "eq",
-        value: reviewDomain,
-      },
-    ],
-  });
-
-  if (possibleReview != null) {
-    const existingReview = possibleReview as Review;
-    const id = existingReview.id;
-    // Update
-    const data = await updateTargetDetails<Review, ReviewDetails>({
-      id,
-      updateFn: (details) => {
-        const incrementResult = validPayload.reviewResult;
-        if (incrementResult != null) {
-          const updatedResult = details.reviewResult != null ? cloneDeep(details.reviewResult) : {};
-          Object.entries(incrementResult).forEach(([key, value]) => {
-            updatedResult[key] = (updatedResult[key] ?? 0) + value;
-          });
-          return {
-            ...details,
-            reviewResult: updatedResult,
-            reviewCount: (details.reviewCount ?? 0) + 1,
-            lastUpdated: Date.now(),
-          };
-        }
-        return details;
-      },
-    });
-    return generateResponse.success<Review>(data);
-  }
-  // Create
-  const { data: newReview } = await postReview({
-    reviewTargetId,
-    reviewDomain,
-  });
-  if (newReview == null) {
-    const msg = "[patchUpsertReview] Unable to create Review";
-    console.error(msg);
-    throw new Error(msg);
-  }
-  return generateResponse.success<Review>(newReview);
-};
-
-export interface PostReviewPayload {
-  reviewTargetId: ReviewDetails["reviewTargetId"];
-  reviewDomain: ReviewDetails["reviewDomain"];
-}
-
-export class PostReviewValidator extends BaseValidator<PostReviewPayload> {
-  protected requiredFields: (keyof PostReviewPayload)[] = ["reviewTargetId", "reviewDomain"];
-  protected optionalFields: (keyof PostReviewPayload)[] = [];
-
-  constructor() {
-    super();
-    // Add custom
-    this.addCustomValidator((val) => {
-      return true;
-    });
-  }
-}
-
-export const postReview = async (payload: PostReviewPayload) => {
-  return createTarget<Review, PostReviewPayload>({
-    payload: payload,
-    validator: PostReviewValidator,
-    checkRedundancyFilterList: [
-      {
-        field: "category",
-        operator: "eq",
-        value: CategoryReview.REVIEW,
-      },
-      {
-        field: "details->>reviewTargetId",
-        operator: "eq",
-        value: payload.reviewTargetId,
-      },
-      {
-        field: "details->>reviewDomain",
-        operator: "eq",
-        value: payload.reviewDomain,
-      },
-    ],
-    createFn: (validPayload) => {
-      const { reviewTargetId, reviewDomain } = validPayload;
-      const details: ReviewDetails = {
-        reviewTargetId,
-        reviewDomain,
-        lastUpdated: Date.now(),
-        reviewCount: 0,
-        reviewResult: {},
-      };
-      const reviewStr = `Review ${reviewTargetId} ${reviewDomain}`;
-      return {
-        name: reviewStr,
-        category: CategoryReview.REVIEW,
-        value: "",
-        tagList: [],
-        details,
-      };
-    },
-  });
-};

package/src/review/review.interface.ts

@@ -1,26 +0,0 @@
-import { Target } from "../core.interface";
-
-export enum ReviewDomain {
-  /** the larger the number, the more popular it is */
-  LIKES = "likes",
-}
-
-export type ReviewDetails = {
-  reviewTargetId: string;
-  lastUpdated: number;
-  reviewDomain: ReviewDomain;
-  /** Auto increment */
-  reviewCount?: number;
-  reviewResult?: {
-    /** reviewDomain */
-    [name: string]: number;
-  };
-};
-
-export enum CategoryReview {
-  REVIEW = "review",
-}
-export interface Review extends Target {
-  category: CategoryReview;
-  details: ReviewDetails;
-}

package/src/review-v2/apis/post-review-setting.api.ts

@@ -1,35 +0,0 @@
-import { createTarget, validateWith } from "../../core.api";
-import { BaseValidator } from "../../core.utils";
-import { ReviewSettingDetails, ReviewSetting, CategoryReviewSetting } from "../review-setting.interface";
-
-export interface PostReviewSettingPayload {
-  name: ReviewSettingDetails["name"];
-  questionList: ReviewSettingDetails["questionList"];
-}
-
-export class PostReviewSettingValidator extends BaseValidator<PostReviewSettingPayload> {
-  protected requiredFields: (keyof PostReviewSettingPayload)[] = ["name", "questionList"];
-  protected optionalFields: (keyof PostReviewSettingPayload)[] = [];
-}
-
-export const postReviewSetting = validateWith<PostReviewSettingPayload, PostReviewSettingValidator>(
-  PostReviewSettingValidator
-)(async (validPayload) => {
-  return createTarget<ReviewSetting, PostReviewSettingPayload>({
-    payload: validPayload,
-    createFn: (validPayload) => {
-      const { name, questionList } = validPayload;
-      const details: ReviewSettingDetails = {
-        name,
-        questionList,
-      };
-      return {
-        name,
-        category: CategoryReviewSetting.REVIEW_SETTING,
-        value: "",
-        tagList: [],
-        details,
-      };
-    },
-  });
-});

package/src/review-v2/apis/post-review.api.ts

@@ -1,59 +0,0 @@
-import { createTarget, getTarget, validateWith } from "../../core.api";
-import { BaseValidator } from "../../core.utils";
-import { CategoryReview, ReviewV2 as Review, ReviewV2Details as ReviewDetails } from "../review.interface";
-import { ReviewSetting } from "../review-setting.interface";
-
-export interface PostReviewPayload {
-  targetId: ReviewDetails["targetId"];
-  settingId: ReviewDetails["settingId"];
-  resultList: ReviewDetails["resultList"];
-}
-
-export class PostReviewValidator extends BaseValidator<PostReviewPayload> {
-  protected requiredFields: (keyof PostReviewPayload)[] = ["targetId", "targetId", "resultList"];
-  protected optionalFields: (keyof PostReviewPayload)[] = [];
-}
-
-export const postReview = validateWith<PostReviewPayload, PostReviewValidator>(PostReviewValidator)(
-  async (validPayload: PostReviewPayload) => {
-    const { targetId, settingId, resultList } = validPayload;
-
-    // Check Target
-    if (targetId != null) {
-      const { data: possibleTarget } = await getTarget({
-        id: targetId,
-      });
-      // TODO
-    }
-
-    // Check ReviewSetting
-    const { data: _reviewSetting } = await getTarget({
-      id: settingId,
-    });
-    if (_reviewSetting == null) {
-      console.error("[postReview] ReviewSetting not found");
-      throw new Error("[postReview] ReviewSetting not found");
-    }
-    const reviewSetting = _reviewSetting as ReviewSetting;
-
-    return createTarget<Review, PostReviewPayload>({
-      payload: validPayload,
-      createFn: (validPayload) => {
-        const { targetId, settingId, resultList } = validPayload;
-        const details: ReviewDetails = {
-          targetId,
-          settingId,
-          resultList,
-        };
-        const name = `Review on ${reviewSetting?.details?.name}`;
-        return {
-          name,
-          category: CategoryReview.REVIEW,
-          value: "",
-          tagList: [],
-          details,
-        };
-      },
-    });
-  }
-);

package/src/review-v2/review-setting.interface.ts

@@ -1,26 +0,0 @@
-import { Target } from "../core.interface";
-
-export interface ReviewSetting extends Target {
-  category: CategoryReviewSetting;
-  details: ReviewSettingDetails;
-}
-
-export enum CategoryReviewSetting {
-  REVIEW_SETTING = "review-setting",
-}
-
-export type ReviewSettingDetails = {
-  name: string;
-  questionList: ReviewQuestion[];
-};
-
-export interface ReviewQuestion {
-  title: string;
-  /** uuid */
-  key: string;
-  type: "$boolean" | "$text" | "$number" | "$choice" | "$custom";
-  /** To provide data when rendering a question */
-  refTargetId?: string;
-  /** To render a custom question */
-  customTargetId?: string;
-}

package/src/review-v2/review.interface.ts

@@ -1,23 +0,0 @@
-import { Target } from "../core.interface";
-import { ReviewQuestion } from "./review-setting.interface";
-
-/** Instance of ReviewSetting */
-export interface ReviewV2 extends Target {
-  category: CategoryReview;
-  details: ReviewV2Details;
-}
-
-export enum CategoryReview {
-  REVIEW = "review",
-}
-
-export type ReviewV2Details = {
-  targetId: string | null;
-  /** How to collect reviews from users and how to parse the results */
-  settingId: string;
-  resultList: ReviewResult[];
-};
-
-export interface ReviewResult extends ReviewQuestion {
-  answer: unknown;
-}

package/src/service/api.interface.ts

@@ -1,47 +0,0 @@
-import { Target } from "../core.interface";
-import { Field, Lifecycle } from "./base.interface";
-
-export interface Api extends Target {
-  /** "core.post.target.0" 唯一键 领域 + METHOD + content + VERSION */
-  value: string;
-  category: CategoryApi;
-  details: ApiDetails;
-}
-
-export enum CategoryApi {
-  API = "api",
-}
-
-export enum ApiMethod {
-  POST = "POST",
-  GET = "GET",
-  PUT = "PUT",
-  DELETE = "DELETE",
-}
-
-export interface ApiDetails {
-  method: ApiMethod;
-  /** /v0/core/target */
-  path: string;
-  request: {
-    query: {
-      [key: string]: Field;
-    };
-  };
-  response: {
-    "200": { [key: string]: Field };
-  };
-  manifestVersion: number;
-  lifecycle: Lifecycle;
-  /** TODO "application/octet-stream" */
-  // contentType: string;
-  /** TODO "application/json" */
-  // responseType: string;
-  /** TODO 安全模型/ 风控 / 限制 / 可观测性 & 审计 */
-  // auth: unknown;
-  // rate_limit: {
-  //   key: "user_id";
-  //   limit: 60;
-  //   window: "1m";
-  // };
-}

package/src/shared/log/create-api-logger.ts

@@ -1,36 +0,0 @@
-import { logManager, type LoggerWithScope } from "./log-manager";
-import { normalizeScope, type LogScope, type LogScopePatch } from "./log-scope";
-
-/**
- * Options for {@link createApiLogger}.
- *
- * - **Trace:** optional `traceId` / `traceParentId` (generated root when traceId omitted)
- * - **Labels:** optional `labels` (e.g. `{ nodeId }`)
- */
-export type CreateApiLoggerOptions = {
-    traceId?: string;
-    traceParentId?: string | null;
-    labels?: Record<string, string>;
-} & Partial<Omit<LogScope, "module" | "traceId" | "traceParentId" | "labels">>;
-
-/**
- * Logger for one SDK API invocation.
- *
- * Binds `module` + normalized {@link LogScope}.
- */
-export function createApiLogger(module: string, options?: CreateApiLoggerOptions): LoggerWithScope {
-    const { traceId, traceParentId, labels, ...rest } = options ?? {};
-    const scope = normalizeScope(
-        {
-            module,
-            traceId,
-            traceParentId: traceParentId ?? null,
-            labels,
-            ...rest,
-        },
-        { generateTraceId: true }
-    );
-    return logManager.withScope(scope).logger;
-}
-
-export type { LogScopePatch };