@synonymdev/pubky 0.10.0 → 0.12.0

package/package.json

@@ -2,11 +2,11 @@
   "name": "@synonymdev/pubky",
   "type": "module",
   "description": "Decentralized identity, auth flows, and user-owned storage",
-  "version": "0.10.0",
+  "version": "0.12.0",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/pubky/pubky-core.git"
+    "url": "git+https://github.com/pubky/pubky-homeserver.git"
   },
   "scripts": {
     "testnet": "cargo run -p pubky-testnet",

package/pubky.d.ts

@@ -51,11 +51,11 @@ export interface XCallbackParams {
  */
 export interface GrantAuthFlowOptions {
     /**
-     * App identifier shown in the user\'s grant/session list, typically a domain.
+     * App identifier shown in the user's grant/session list, typically a domain.
      */
     clientId: string;
     /**
-     * Optional HTTP relay base, e.g. `\"https://demo.httprelay.io/inbox/\"`.
+     * Optional HTTP relay base, e.g. `"https://demo.httprelay.io/inbox/"`.
      * Defaults to the default Synonym-hosted relay when omitted.
      */
     relay?: string | null;
@@ -137,10 +137,10 @@ export interface PubkyError extends Error {
  * } catch (e) {
  *   const error = e as PubkyError;
  *   if (
- *     error.name === \'RequestError\' &&
- *     typeof error.data === \'object\' &&
+ *     error.name === 'RequestError' &&
+ *     typeof error.data === 'object' &&
  *     error.data !== null &&
- *     \'statusCode\' in error.data &&
+ *     'statusCode' in error.data &&
  *     (error.data as { statusCode?: number }).statusCode === 404
  *   ) {
  *     // Handle not found...
@@ -162,7 +162,7 @@ export interface PubkyError {
  *
  * @typedef {Object} ResourceStats
  * @property {number=} contentLength  Size in bytes.
- * @property {string=} contentType    Media type (e.g. \"application/json; charset=utf-8\").
+ * @property {string=} contentType    Media type (e.g. "application/json; charset=utf-8").
  * @property {number=} lastModifiedMs Unix epoch milliseconds.
  * @property {string=} etag           Opaque server ETag for the current version.
  *
@@ -183,7 +183,7 @@ export interface ResourceStats {
      */
     contentLength?: number;
     /**
-     * Media type of the stored object (e.g., `\"application/json\"`).
+     * Media type of the stored object (e.g., `"application/json"`).
      */
     contentType?: string;
     /**
@@ -256,6 +256,8 @@ export class AuthFlow {
      * @returns {AuthFlow} A flow reconnected to the original relay channel.
      * @throws {PubkyError}
      * - `{ name: "AuthenticationError" }` if the URL is invalid or not a signin/signup link
+     *
+     * @deprecated Use `GrantAuthFlow.resume(...)` instead.
      */
     static resume(authorization_url: string): AuthFlow;
     /**
@@ -501,7 +503,7 @@ export class Client {
      *
      * @example
      * const client = pubky.client;
-     * const res = await client.fetch(`https://_pubky.${user}/pub/app/file.txt`, { method: "PUT", body: "hi", credentials: "include" });
+     * const res = await client.fetch(`https://_pubky.${user}/storage/${user}/pub/app/file.txt`, { method: "PUT", body: "hi", credentials: "include" });
      */
     fetch(url: string, init?: RequestInit | null): Promise<Response>;
     /**
@@ -549,8 +551,9 @@ export class Client {
 /**
  * Cookie-only view over a cookie-backed `Session`.
  *
- * Grant-backed sessions do not expose this view; use `session.cookie` and
- * check for `undefined` before calling cookie-specific methods.
+ * New applications should use `session.grant` and `GrantSession`.
+ *
+ * @deprecated Use `GrantSession` instead.
  */
 export class CookieSession {
     private constructor();
@@ -563,6 +566,7 @@ export class CookieSession {
      * still hold the HTTP-only cookie.
      *
      * @returns {string}
+     * @deprecated Use `GrantSession.exportLocalSecret()` instead.
      */
     export(): string;
     /**
@@ -572,6 +576,7 @@ export class CookieSession {
      * Node.js. Browser sessions cannot read HTTP-only Set-Cookie values.
      *
      * @returns {Promise<string>}
+     * @deprecated Use `GrantSession.exportLocalSecret()` instead.
      */
     exportSecret(): Promise<string>;
 }
@@ -1291,6 +1296,8 @@ export class Pubky {
      *     sessionStorage.removeItem("pubky-auth-url");
      *   }
      * }
+     *
+     * @deprecated Use `resumeGrantAuthFlow(...)` instead.
      */
     resumeCookieAuthFlow(authorization_url: string): AuthFlow;
     /**
@@ -1356,6 +1363,8 @@ export class Pubky {
      * const flow = pubky.startCookieAuthFlow("/pub/my-cool-app/:rw");
      * renderQr(flow.authorizationUrl);
      * const session = await flow.awaitApproval();
+     *
+     * @deprecated Use `startGrantAuthFlow(...)` instead.
      */
     startCookieAuthFlow(capabilities: Capabilities, kind: AuthFlowKind, relay?: string | null, x_callback?: XCallbackParams | null): AuthFlow;
     /**
@@ -1605,7 +1614,7 @@ export class Session {
      * @returns {string}
      * A base64 string to store (e.g. in `localStorage`).
      *
-     * @deprecated Prefer `exportLocalSecret()` for grant sessions.
+     * @deprecated Use `GrantSession.exportLocalSecret()` instead.
      */
     export(): string;
     /**
@@ -1635,7 +1644,7 @@ export class Session {
      * Optional client to reuse transport configuration.
      * @returns {Promise<Session>}
      *
-     * @deprecated Prefer `Pubky.restoreSession(...)`.
+     * @deprecated Use `Pubky.restoreSession(...)` with a grant secret.
      */
     static restore(exported: string, client?: Client | null): Promise<Session>;
     /**
@@ -1651,6 +1660,7 @@ export class Session {
      * Grant-backed sessions return `undefined`.
      *
      * @returns {CookieSession|undefined}
+     * @deprecated Use `session.grant` and `GrantSession` instead.
      */
     readonly cookie: CookieSession | undefined;
     /**
@@ -2113,7 +2123,7 @@ export class StoredSessionInfo {
  * Resolve a `pubky://` or `pubky<pk>/…` identifier into the homeserver transport URL.
  *
  * @param {string} identifier Either `pubky<pk>/...` (preferred) or `pubky://<pk>/...`.
- * @returns {string} HTTPS URL in the form `https://_pubky.<pk>/...`.
+ * @returns {string} HTTPS URL in the form `https://_pubky.<pk>/storage/<pk>/...`.
  */
 export function resolvePubky(identifier: string): string;