@knpkv/confluence-to-markdown 0.2.0 → 0.4.1

package/src/Schemas.ts

@@ -31,10 +31,14 @@ export const ConfluenceConfigFileSchema = Schema.Struct({
   ),
   /** Optional space key */
   spaceKey: Schema.optional(SpaceKeySchema),
-  /** Local docs path (default: .docs/confluence) */
-  docsPath: Schema.optionalWith(Schema.String, { default: () => ".docs/confluence" }),
+  /** Local docs path (default: .confluence/docs) */
+  docsPath: Schema.optionalWith(Schema.String, { default: () => ".confluence/docs" }),
   /** Glob patterns to exclude from sync */
-  excludePatterns: Schema.optionalWith(Schema.Array(Schema.String), { default: () => [] })
+  excludePatterns: Schema.optionalWith(Schema.Array(Schema.String), { default: () => [] }),
+  /** Save original Confluence HTML alongside markdown (default: false) */
+  saveSource: Schema.optionalWith(Schema.Boolean, { default: () => false }),
+  /** Glob patterns for files to track in git */
+  trackedPaths: Schema.optionalWith(Schema.Array(Schema.String), { default: () => ["**/*.md"] })
 })
 
 /**
@@ -77,7 +81,13 @@ export const PageFrontMatterSchema = Schema.Struct({
   /** Position among siblings (optional) */
   position: Schema.optional(Schema.Number),
   /** SHA256 hash of content for change detection */
-  contentHash: ContentHashSchema
+  contentHash: ContentHashSchema,
+  /** Version message from Confluence (used as git commit message) */
+  versionMessage: Schema.optional(Schema.String),
+  /** Author display name */
+  authorName: Schema.optional(Schema.String),
+  /** Author email */
+  authorEmail: Schema.optional(Schema.String)
 })
 
 /**
@@ -143,10 +153,13 @@ export type SyncState = Schema.Schema.Type<typeof SyncStateSchema>
 export const PageResponseSchema = Schema.Struct({
   id: Schema.String,
   title: Schema.String,
+  spaceId: Schema.optional(Schema.String),
   status: Schema.optional(Schema.String),
   version: Schema.Struct({
     number: Schema.Number,
-    createdAt: Schema.optional(Schema.String)
+    createdAt: Schema.optional(Schema.String),
+    message: Schema.optional(Schema.String),
+    authorId: Schema.optional(Schema.String)
   }),
   body: Schema.optional(
     Schema.Struct({
@@ -185,7 +198,9 @@ export const PageListItemSchema = Schema.Struct({
   status: Schema.optional(Schema.String),
   version: Schema.optional(Schema.Struct({
     number: Schema.Number,
-    createdAt: Schema.optional(Schema.String)
+    createdAt: Schema.optional(Schema.String),
+    message: Schema.optional(Schema.String),
+    authorId: Schema.optional(Schema.String)
   })),
   body: Schema.optional(
     Schema.Struct({
@@ -233,3 +248,205 @@ export const PageChildrenResponseSchema = Schema.Struct({
  * @category Types
  */
 export type PageChildrenResponse = Schema.Schema.Type<typeof PageChildrenResponseSchema>
+
+/**
+ * Schema for OAuth user info.
+ *
+ * @category Schema
+ */
+export const OAuthUserSchema = Schema.Struct({
+  /** Atlassian account ID */
+  account_id: Schema.String,
+  /** Display name */
+  name: Schema.String,
+  /** Email address */
+  email: Schema.String
+})
+
+/**
+ * Type for OAuth user info.
+ *
+ * @category Types
+ */
+export type OAuthUser = Schema.Schema.Type<typeof OAuthUserSchema>
+
+/**
+ * Schema for stored OAuth token.
+ *
+ * @example
+ * ```typescript
+ * import { OAuthTokenSchema } from "@knpkv/confluence-to-markdown/Schemas"
+ * import * as Schema from "effect/Schema"
+ *
+ * const token = Schema.decodeUnknownSync(OAuthTokenSchema)({
+ *   access_token: "eyJ...",
+ *   refresh_token: "eyJ...",
+ *   expires_at: Date.now() + 3600000,
+ *   scope: "read:confluence-content.all",
+ *   cloud_id: "abc123",
+ *   site_url: "https://mysite.atlassian.net"
+ * })
+ * ```
+ *
+ * @category Schema
+ */
+export const OAuthTokenSchema = Schema.Struct({
+  /** OAuth access token */
+  access_token: Schema.String,
+  /** OAuth refresh token */
+  refresh_token: Schema.String,
+  /** Token expiration timestamp (Unix ms) */
+  expires_at: Schema.Number,
+  /** Granted scopes */
+  scope: Schema.String,
+  /** Atlassian Cloud site ID */
+  cloud_id: Schema.String,
+  /** Confluence site URL */
+  site_url: Schema.String,
+  /** Cached user info */
+  user: Schema.optional(OAuthUserSchema)
+})
+
+/**
+ * Type for stored OAuth token.
+ *
+ * @category Types
+ */
+export type OAuthToken = Schema.Schema.Type<typeof OAuthTokenSchema>
+
+/**
+ * Schema for OAuth client configuration.
+ *
+ * @category Schema
+ */
+export const OAuthConfigSchema = Schema.Struct({
+  /** OAuth client ID from Atlassian Developer Console */
+  clientId: Schema.String,
+  /** OAuth client secret */
+  clientSecret: Schema.String
+})
+
+/**
+ * Type for OAuth client configuration.
+ *
+ * @category Types
+ */
+export type OAuthConfig = Schema.Schema.Type<typeof OAuthConfigSchema>
+
+/**
+ * Schema for Atlassian user info.
+ *
+ * @category Schema
+ */
+export const AtlassianUserSchema = Schema.Struct({
+  /** Atlassian account ID */
+  accountId: Schema.String,
+  /** Display name */
+  displayName: Schema.String,
+  /** Email address (may be empty for privacy settings) */
+  email: Schema.optional(Schema.String),
+  /** Public name */
+  publicName: Schema.optional(Schema.String)
+})
+
+/**
+ * Type for Atlassian user info.
+ *
+ * @category Types
+ */
+export type AtlassianUser = Schema.Schema.Type<typeof AtlassianUserSchema>
+
+/**
+ * Schema for page version info (from versions list).
+ *
+ * @category Schema
+ */
+export const PageVersionSchema = Schema.Struct({
+  /** Version number */
+  number: Schema.Number,
+  /** Author account ID */
+  authorId: Schema.optional(Schema.String),
+  /** Creation timestamp */
+  createdAt: Schema.String,
+  /** Version message/comment */
+  message: Schema.optional(Schema.String),
+  /** Page info with title and body (when body-format is requested) */
+  page: Schema.optional(
+    Schema.Struct({
+      id: Schema.optional(Schema.String),
+      title: Schema.optional(Schema.String),
+      body: Schema.optional(
+        Schema.Struct({
+          storage: Schema.optional(
+            Schema.Struct({
+              value: Schema.String,
+              representation: Schema.optional(Schema.String)
+            })
+          )
+        })
+      )
+    })
+  )
+})
+
+/**
+ * Type for page version info.
+ *
+ * @category Types
+ */
+export type PageVersion = Schema.Schema.Type<typeof PageVersionSchema>
+
+/**
+ * Schema for page version with content.
+ *
+ * @category Schema
+ */
+export const PageVersionContentSchema = Schema.Struct({
+  /** Version number */
+  number: Schema.Number,
+  /** Author account ID */
+  authorId: Schema.optional(Schema.String),
+  /** Creation timestamp */
+  createdAt: Schema.String,
+  /** Version message/comment */
+  message: Schema.optional(Schema.String),
+  /** Page content */
+  body: Schema.optional(
+    Schema.Struct({
+      storage: Schema.optional(
+        Schema.Struct({
+          value: Schema.String,
+          representation: Schema.optional(Schema.String)
+        })
+      )
+    })
+  )
+})
+
+/**
+ * Type for page version with content.
+ *
+ * @category Types
+ */
+export type PageVersionContent = Schema.Schema.Type<typeof PageVersionContentSchema>
+
+/**
+ * Schema for page versions API response.
+ *
+ * @category Schema
+ */
+export const PageVersionsResponseSchema = Schema.Struct({
+  results: Schema.Array(PageVersionSchema),
+  _links: Schema.optional(
+    Schema.Struct({
+      next: Schema.optional(Schema.String)
+    })
+  )
+})
+
+/**
+ * Type for page versions response.
+ *
+ * @category Types
+ */
+export type PageVersionsResponse = Schema.Schema.Type<typeof PageVersionsResponseSchema>