@feelflow/ffid-sdk 0.1.0 → 0.2.0

package/dist/announcements/index.cjs

@@ -0,0 +1,109 @@
+'use strict';
+
+var chunkP5PPUZGX_cjs = require('../chunk-P5PPUZGX.cjs');
+
+// src/announcements/ffid-announcements-client.ts
+var API_PATH = "/api/v1/announcements";
+var SDK_LOG_PREFIX = "[FFID Announcements SDK]";
+var FFID_ANNOUNCEMENTS_ERROR_CODES = {
+  /** Network request failed (fetch threw) */
+  NETWORK_ERROR: "NETWORK_ERROR",
+  /** Failed to parse server response as JSON */
+  PARSE_ERROR: "PARSE_ERROR",
+  /** Server returned error without structured error body */
+  UNKNOWN_ERROR: "UNKNOWN_ERROR"
+};
+var quietLogger = {
+  debug: () => {
+  },
+  info: () => {
+  },
+  warn: () => {
+  },
+  error: (...args) => console.error(SDK_LOG_PREFIX, ...args)
+};
+var consoleLogger = {
+  debug: (...args) => console.debug(SDK_LOG_PREFIX, ...args),
+  info: (...args) => console.info(SDK_LOG_PREFIX, ...args),
+  warn: (...args) => console.warn(SDK_LOG_PREFIX, ...args),
+  error: (...args) => console.error(SDK_LOG_PREFIX, ...args)
+};
+function createFFIDAnnouncementsClient(config = {}) {
+  const baseUrl = config.apiBaseUrl ?? chunkP5PPUZGX_cjs.DEFAULT_API_BASE_URL;
+  const logger = config.logger ?? (config.debug ? consoleLogger : quietLogger);
+  async function fetchApi(endpoint) {
+    const url = `${baseUrl}${endpoint}`;
+    logger.debug("Fetching:", url);
+    let response;
+    try {
+      response = await fetch(url, {
+        headers: {
+          Accept: "application/json"
+        }
+      });
+    } catch (error) {
+      logger.error("Network error:", { url, error });
+      return {
+        error: {
+          code: FFID_ANNOUNCEMENTS_ERROR_CODES.NETWORK_ERROR,
+          message: error instanceof Error ? error.message : "\u30CD\u30C3\u30C8\u30EF\u30FC\u30AF\u30A8\u30E9\u30FC\u304C\u767A\u751F\u3057\u307E\u3057\u305F"
+        }
+      };
+    }
+    let data;
+    try {
+      data = await response.json();
+    } catch (parseError) {
+      logger.error("Parse error:", { url, status: response.status, parseError });
+      return {
+        error: {
+          code: FFID_ANNOUNCEMENTS_ERROR_CODES.PARSE_ERROR,
+          message: `\u30B5\u30FC\u30D0\u30FC\u304B\u3089\u4E0D\u6B63\u306A\u30EC\u30B9\u30DD\u30F3\u30B9\u3092\u53D7\u4FE1\u3057\u307E\u3057\u305F (status: ${response.status})`
+        }
+      };
+    }
+    logger.debug("Response:", response.status, data);
+    if (!response.ok || !data.success) {
+      return {
+        error: data.error ?? {
+          code: FFID_ANNOUNCEMENTS_ERROR_CODES.UNKNOWN_ERROR,
+          message: "\u4E0D\u660E\u306A\u30A8\u30E9\u30FC\u304C\u767A\u751F\u3057\u307E\u3057\u305F"
+        }
+      };
+    }
+    if (data.data === void 0) {
+      return {
+        error: {
+          code: FFID_ANNOUNCEMENTS_ERROR_CODES.UNKNOWN_ERROR,
+          message: "\u30B5\u30FC\u30D0\u30FC\u304B\u3089\u30C7\u30FC\u30BF\u304C\u8FD4\u3055\u308C\u307E\u305B\u3093\u3067\u3057\u305F"
+        }
+      };
+    }
+    return { data: data.data };
+  }
+  async function listAnnouncements(options = {}) {
+    const params = new URLSearchParams();
+    if (options.limit !== void 0) {
+      const limit = Math.max(0, Math.floor(options.limit));
+      params.set("limit", String(limit));
+    }
+    if (options.offset !== void 0) {
+      const offset = Math.max(0, Math.floor(options.offset));
+      params.set("offset", String(offset));
+    }
+    const query = params.toString();
+    const endpoint = query ? `${API_PATH}?${query}` : API_PATH;
+    return fetchApi(endpoint);
+  }
+  return {
+    /** List published announcements */
+    listAnnouncements,
+    /** Resolved logger instance */
+    logger,
+    /** API base URL */
+    baseUrl
+  };
+}
+
+exports.FFID_ANNOUNCEMENTS_ERROR_CODES = FFID_ANNOUNCEMENTS_ERROR_CODES;
+exports.createFFIDAnnouncementsClient = createFFIDAnnouncementsClient;

package/dist/announcements/index.d.cts

@@ -0,0 +1,165 @@
+/**
+ * FFID Announcements SDK Type Definitions
+ *
+ * Types for the FeelFlow ID Announcements SDK.
+ * Used by client applications to fetch and display announcements.
+ * Issue: #286
+ */
+/**
+ * Announcement type values.
+ * Uses string union with open extension for forward compatibility.
+ */
+type AnnouncementType = 'maintenance.scheduled' | 'maintenance.reminder' | 'maintenance.started' | 'maintenance.completed' | 'incident.detected' | 'incident.resolved' | 'api.deprecation' | 'api.breaking_change' | 'sdk.update_available' | 'security.advisory' | 'billing.payment_reminder' | 'billing.payment_failed' | 'legal.terms_updated' | 'account.security_alert' | (string & {});
+/** Announcement status (only 'published' is visible via public API) */
+type AnnouncementStatus = 'draft' | 'published' | 'archived';
+/** Single announcement returned from the public API */
+interface Announcement {
+    /** Announcement ID (UUID) */
+    id: string;
+    /** Announcement type */
+    type: AnnouncementType;
+    /** Title */
+    title: string;
+    /** Content (Markdown) */
+    content: string;
+    /** Announcement status */
+    status: AnnouncementStatus;
+    /** Scheduled maintenance start time (ISO 8601) */
+    scheduledAt: string | null;
+    /** Maintenance duration in minutes */
+    durationMinutes: number | null;
+    /** Affected service codes */
+    affectedServices: string[];
+    /** Notification channels */
+    channels: string[];
+    /** When the announcement was published (ISO 8601) */
+    publishedAt: string | null;
+    /** Created timestamp (ISO 8601) */
+    createdAt: string;
+    /** Updated timestamp (ISO 8601) */
+    updatedAt: string;
+}
+/** Response from list announcements endpoint */
+interface AnnouncementListResponse {
+    /** List of announcements */
+    announcements: Announcement[];
+    /** Total number of matching announcements */
+    total: number;
+}
+/** Options for listing announcements */
+interface ListAnnouncementsOptions {
+    /** Number of items to return (server default: 20, server max: 100) */
+    limit?: number;
+    /** Offset for pagination (default: 0) */
+    offset?: number;
+}
+/** Configuration for the FFID Announcements Client */
+interface FFIDAnnouncementsClientConfig {
+    /** FFID API base URL (defaults to https://id.feelflow.co.jp) */
+    apiBaseUrl?: string | undefined;
+    /** Enable debug logging */
+    debug?: boolean | undefined;
+    /** Custom logger */
+    logger?: FFIDAnnouncementsLogger | undefined;
+}
+/** Logger interface for Announcements SDK */
+interface FFIDAnnouncementsLogger {
+    debug: (...args: unknown[]) => void;
+    info: (...args: unknown[]) => void;
+    warn: (...args: unknown[]) => void;
+    error: (...args: unknown[]) => void;
+}
+/**
+ * API response wrapper (discriminated union for type safety)
+ *
+ * Either data is present (success) or error is present (failure), never both.
+ */
+type FFIDAnnouncementsApiResponse<T> = {
+    data: T;
+    error?: undefined;
+} | {
+    data?: undefined;
+    error: FFIDAnnouncementsError;
+};
+/**
+ * Known SDK error codes.
+ * Uses string union with open extension for forward compatibility with server error codes.
+ */
+type FFIDAnnouncementsErrorCode = 'NETWORK_ERROR' | 'PARSE_ERROR' | 'UNKNOWN_ERROR' | (string & {});
+/** Error from the Announcements SDK */
+interface FFIDAnnouncementsError {
+    /** Error code (known SDK codes provide autocomplete; server codes also accepted) */
+    code: FFIDAnnouncementsErrorCode;
+    /** Human-readable error message */
+    message: string;
+}
+/** Server response envelope */
+type FFIDAnnouncementsServerResponse<T> = {
+    success: true;
+    data: T;
+    error?: undefined;
+} | {
+    success: false;
+    data?: undefined;
+    error?: {
+        code: string;
+        message: string;
+    };
+};
+
+/**
+ * FFID Announcements API Client
+ *
+ * Handles API communication for public announcements.
+ * No authentication required - this is a public endpoint.
+ *
+ * @example
+ * ```typescript
+ * import { createFFIDAnnouncementsClient } from '@feelflow/ffid-sdk/announcements'
+ *
+ * const client = createFFIDAnnouncementsClient({
+ *   apiBaseUrl: 'https://id.feelflow.co.jp',
+ * })
+ *
+ * const { data, error } = await client.listAnnouncements({ limit: 10 })
+ * if (data) {
+ *   console.log(`Found ${data.total} announcements`)
+ * }
+ * ```
+ */
+
+/**
+ * Error codes used by the Announcements SDK
+ */
+declare const FFID_ANNOUNCEMENTS_ERROR_CODES: {
+    /** Network request failed (fetch threw) */
+    readonly NETWORK_ERROR: "NETWORK_ERROR";
+    /** Failed to parse server response as JSON */
+    readonly PARSE_ERROR: "PARSE_ERROR";
+    /** Server returned error without structured error body */
+    readonly UNKNOWN_ERROR: "UNKNOWN_ERROR";
+};
+/**
+ * Creates an FFID Announcements API client instance
+ *
+ * @param config - Client configuration (optional, uses defaults)
+ * @returns Announcements client instance
+ *
+ * @example
+ * ```typescript
+ * const client = createFFIDAnnouncementsClient()
+ * const { data, error } = await client.listAnnouncements()
+ * ```
+ */
+declare function createFFIDAnnouncementsClient(config?: FFIDAnnouncementsClientConfig): {
+    /** List published announcements */
+    listAnnouncements: (options?: ListAnnouncementsOptions) => Promise<FFIDAnnouncementsApiResponse<AnnouncementListResponse>>;
+    /** Resolved logger instance */
+    logger: FFIDAnnouncementsLogger;
+    /** API base URL */
+    baseUrl: string;
+};
+/** Type of the FFID Announcements client */
+type FFIDAnnouncementsClient = ReturnType<typeof createFFIDAnnouncementsClient>;
+
+export { type Announcement, type AnnouncementListResponse, type AnnouncementStatus, type AnnouncementType, type FFIDAnnouncementsApiResponse, type FFIDAnnouncementsClient, type FFIDAnnouncementsClientConfig, type FFIDAnnouncementsError, type FFIDAnnouncementsErrorCode, type FFIDAnnouncementsLogger, type FFIDAnnouncementsServerResponse, FFID_ANNOUNCEMENTS_ERROR_CODES, type ListAnnouncementsOptions, createFFIDAnnouncementsClient };

package/dist/announcements/index.d.ts

@@ -0,0 +1,165 @@
+/**
+ * FFID Announcements SDK Type Definitions
+ *
+ * Types for the FeelFlow ID Announcements SDK.
+ * Used by client applications to fetch and display announcements.
+ * Issue: #286
+ */
+/**
+ * Announcement type values.
+ * Uses string union with open extension for forward compatibility.
+ */
+type AnnouncementType = 'maintenance.scheduled' | 'maintenance.reminder' | 'maintenance.started' | 'maintenance.completed' | 'incident.detected' | 'incident.resolved' | 'api.deprecation' | 'api.breaking_change' | 'sdk.update_available' | 'security.advisory' | 'billing.payment_reminder' | 'billing.payment_failed' | 'legal.terms_updated' | 'account.security_alert' | (string & {});
+/** Announcement status (only 'published' is visible via public API) */
+type AnnouncementStatus = 'draft' | 'published' | 'archived';
+/** Single announcement returned from the public API */
+interface Announcement {
+    /** Announcement ID (UUID) */
+    id: string;
+    /** Announcement type */
+    type: AnnouncementType;
+    /** Title */
+    title: string;
+    /** Content (Markdown) */
+    content: string;
+    /** Announcement status */
+    status: AnnouncementStatus;
+    /** Scheduled maintenance start time (ISO 8601) */
+    scheduledAt: string | null;
+    /** Maintenance duration in minutes */
+    durationMinutes: number | null;
+    /** Affected service codes */
+    affectedServices: string[];
+    /** Notification channels */
+    channels: string[];
+    /** When the announcement was published (ISO 8601) */
+    publishedAt: string | null;
+    /** Created timestamp (ISO 8601) */
+    createdAt: string;
+    /** Updated timestamp (ISO 8601) */
+    updatedAt: string;
+}
+/** Response from list announcements endpoint */
+interface AnnouncementListResponse {
+    /** List of announcements */
+    announcements: Announcement[];
+    /** Total number of matching announcements */
+    total: number;
+}
+/** Options for listing announcements */
+interface ListAnnouncementsOptions {
+    /** Number of items to return (server default: 20, server max: 100) */
+    limit?: number;
+    /** Offset for pagination (default: 0) */
+    offset?: number;
+}
+/** Configuration for the FFID Announcements Client */
+interface FFIDAnnouncementsClientConfig {
+    /** FFID API base URL (defaults to https://id.feelflow.co.jp) */
+    apiBaseUrl?: string | undefined;
+    /** Enable debug logging */
+    debug?: boolean | undefined;
+    /** Custom logger */
+    logger?: FFIDAnnouncementsLogger | undefined;
+}
+/** Logger interface for Announcements SDK */
+interface FFIDAnnouncementsLogger {
+    debug: (...args: unknown[]) => void;
+    info: (...args: unknown[]) => void;
+    warn: (...args: unknown[]) => void;
+    error: (...args: unknown[]) => void;
+}
+/**
+ * API response wrapper (discriminated union for type safety)
+ *
+ * Either data is present (success) or error is present (failure), never both.
+ */
+type FFIDAnnouncementsApiResponse<T> = {
+    data: T;
+    error?: undefined;
+} | {
+    data?: undefined;
+    error: FFIDAnnouncementsError;
+};
+/**
+ * Known SDK error codes.
+ * Uses string union with open extension for forward compatibility with server error codes.
+ */
+type FFIDAnnouncementsErrorCode = 'NETWORK_ERROR' | 'PARSE_ERROR' | 'UNKNOWN_ERROR' | (string & {});
+/** Error from the Announcements SDK */
+interface FFIDAnnouncementsError {
+    /** Error code (known SDK codes provide autocomplete; server codes also accepted) */
+    code: FFIDAnnouncementsErrorCode;
+    /** Human-readable error message */
+    message: string;
+}
+/** Server response envelope */
+type FFIDAnnouncementsServerResponse<T> = {
+    success: true;
+    data: T;
+    error?: undefined;
+} | {
+    success: false;
+    data?: undefined;
+    error?: {
+        code: string;
+        message: string;
+    };
+};
+
+/**
+ * FFID Announcements API Client
+ *
+ * Handles API communication for public announcements.
+ * No authentication required - this is a public endpoint.
+ *
+ * @example
+ * ```typescript
+ * import { createFFIDAnnouncementsClient } from '@feelflow/ffid-sdk/announcements'
+ *
+ * const client = createFFIDAnnouncementsClient({
+ *   apiBaseUrl: 'https://id.feelflow.co.jp',
+ * })
+ *
+ * const { data, error } = await client.listAnnouncements({ limit: 10 })
+ * if (data) {
+ *   console.log(`Found ${data.total} announcements`)
+ * }
+ * ```
+ */
+
+/**
+ * Error codes used by the Announcements SDK
+ */
+declare const FFID_ANNOUNCEMENTS_ERROR_CODES: {
+    /** Network request failed (fetch threw) */
+    readonly NETWORK_ERROR: "NETWORK_ERROR";
+    /** Failed to parse server response as JSON */
+    readonly PARSE_ERROR: "PARSE_ERROR";
+    /** Server returned error without structured error body */
+    readonly UNKNOWN_ERROR: "UNKNOWN_ERROR";
+};
+/**
+ * Creates an FFID Announcements API client instance
+ *
+ * @param config - Client configuration (optional, uses defaults)
+ * @returns Announcements client instance
+ *
+ * @example
+ * ```typescript
+ * const client = createFFIDAnnouncementsClient()
+ * const { data, error } = await client.listAnnouncements()
+ * ```
+ */
+declare function createFFIDAnnouncementsClient(config?: FFIDAnnouncementsClientConfig): {
+    /** List published announcements */
+    listAnnouncements: (options?: ListAnnouncementsOptions) => Promise<FFIDAnnouncementsApiResponse<AnnouncementListResponse>>;
+    /** Resolved logger instance */
+    logger: FFIDAnnouncementsLogger;
+    /** API base URL */
+    baseUrl: string;
+};
+/** Type of the FFID Announcements client */
+type FFIDAnnouncementsClient = ReturnType<typeof createFFIDAnnouncementsClient>;
+
+export { type Announcement, type AnnouncementListResponse, type AnnouncementStatus, type AnnouncementType, type FFIDAnnouncementsApiResponse, type FFIDAnnouncementsClient, type FFIDAnnouncementsClientConfig, type FFIDAnnouncementsError, type FFIDAnnouncementsErrorCode, type FFIDAnnouncementsLogger, type FFIDAnnouncementsServerResponse, FFID_ANNOUNCEMENTS_ERROR_CODES, type ListAnnouncementsOptions, createFFIDAnnouncementsClient };

package/dist/announcements/index.js

@@ -0,0 +1,106 @@
+import { DEFAULT_API_BASE_URL } from '../chunk-P4MLCG4T.js';
+
+// src/announcements/ffid-announcements-client.ts
+var API_PATH = "/api/v1/announcements";
+var SDK_LOG_PREFIX = "[FFID Announcements SDK]";
+var FFID_ANNOUNCEMENTS_ERROR_CODES = {
+  /** Network request failed (fetch threw) */
+  NETWORK_ERROR: "NETWORK_ERROR",
+  /** Failed to parse server response as JSON */
+  PARSE_ERROR: "PARSE_ERROR",
+  /** Server returned error without structured error body */
+  UNKNOWN_ERROR: "UNKNOWN_ERROR"
+};
+var quietLogger = {
+  debug: () => {
+  },
+  info: () => {
+  },
+  warn: () => {
+  },
+  error: (...args) => console.error(SDK_LOG_PREFIX, ...args)
+};
+var consoleLogger = {
+  debug: (...args) => console.debug(SDK_LOG_PREFIX, ...args),
+  info: (...args) => console.info(SDK_LOG_PREFIX, ...args),
+  warn: (...args) => console.warn(SDK_LOG_PREFIX, ...args),
+  error: (...args) => console.error(SDK_LOG_PREFIX, ...args)
+};
+function createFFIDAnnouncementsClient(config = {}) {
+  const baseUrl = config.apiBaseUrl ?? DEFAULT_API_BASE_URL;
+  const logger = config.logger ?? (config.debug ? consoleLogger : quietLogger);
+  async function fetchApi(endpoint) {
+    const url = `${baseUrl}${endpoint}`;
+    logger.debug("Fetching:", url);
+    let response;
+    try {
+      response = await fetch(url, {
+        headers: {
+          Accept: "application/json"
+        }
+      });
+    } catch (error) {
+      logger.error("Network error:", { url, error });
+      return {
+        error: {
+          code: FFID_ANNOUNCEMENTS_ERROR_CODES.NETWORK_ERROR,
+          message: error instanceof Error ? error.message : "\u30CD\u30C3\u30C8\u30EF\u30FC\u30AF\u30A8\u30E9\u30FC\u304C\u767A\u751F\u3057\u307E\u3057\u305F"
+        }
+      };
+    }
+    let data;
+    try {
+      data = await response.json();
+    } catch (parseError) {
+      logger.error("Parse error:", { url, status: response.status, parseError });
+      return {
+        error: {
+          code: FFID_ANNOUNCEMENTS_ERROR_CODES.PARSE_ERROR,
+          message: `\u30B5\u30FC\u30D0\u30FC\u304B\u3089\u4E0D\u6B63\u306A\u30EC\u30B9\u30DD\u30F3\u30B9\u3092\u53D7\u4FE1\u3057\u307E\u3057\u305F (status: ${response.status})`
+        }
+      };
+    }
+    logger.debug("Response:", response.status, data);
+    if (!response.ok || !data.success) {
+      return {
+        error: data.error ?? {
+          code: FFID_ANNOUNCEMENTS_ERROR_CODES.UNKNOWN_ERROR,
+          message: "\u4E0D\u660E\u306A\u30A8\u30E9\u30FC\u304C\u767A\u751F\u3057\u307E\u3057\u305F"
+        }
+      };
+    }
+    if (data.data === void 0) {
+      return {
+        error: {
+          code: FFID_ANNOUNCEMENTS_ERROR_CODES.UNKNOWN_ERROR,
+          message: "\u30B5\u30FC\u30D0\u30FC\u304B\u3089\u30C7\u30FC\u30BF\u304C\u8FD4\u3055\u308C\u307E\u305B\u3093\u3067\u3057\u305F"
+        }
+      };
+    }
+    return { data: data.data };
+  }
+  async function listAnnouncements(options = {}) {
+    const params = new URLSearchParams();
+    if (options.limit !== void 0) {
+      const limit = Math.max(0, Math.floor(options.limit));
+      params.set("limit", String(limit));
+    }
+    if (options.offset !== void 0) {
+      const offset = Math.max(0, Math.floor(options.offset));
+      params.set("offset", String(offset));
+    }
+    const query = params.toString();
+    const endpoint = query ? `${API_PATH}?${query}` : API_PATH;
+    return fetchApi(endpoint);
+  }
+  return {
+    /** List published announcements */
+    listAnnouncements,
+    /** Resolved logger instance */
+    logger,
+    /** API base URL */
+    baseUrl
+  };
+}
+
+export { FFID_ANNOUNCEMENTS_ERROR_CODES, createFFIDAnnouncementsClient };