@yorkie-js/react 0.6.0 → 0.6.1-rc1

package/package.json

@@ -1,15 +1,22 @@
 {
   "name": "@yorkie-js/react",
-  "version": "0.6.0",
+  "version": "0.6.1-rc1",
   "description": "A set of hooks and providers for Yorkie JS SDK",
   "main": "./dist/yorkie-js-react.js",
   "publishConfig": {
     "access": "public"
   },
+  "files": [
+    "dist",
+    "README.md"
+  ],
   "dependencies": {
     "react": "^19.0.0",
     "@yorkie-js/sdk": "0.6.0"
   },
+  "peerDependencies": {
+    "react": "^19"
+  },
   "devDependencies": {
     "@types/react": "^19.0.10",
     "typescript": "^5.3.3",

package/lib/index.js

@@ -1,17 +0,0 @@
-/*
- * Copyright 2025 The Yorkie Authors. All rights reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { useDocument } from './useDocument';
-export { useDocument };

package/lib/useDocument.js

@@ -1,88 +0,0 @@
-/*
- * Copyright 2025 The Yorkie Authors. All rights reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { useCallback, useEffect, useState } from 'react';
-import { Client, Document } from '@yorkie-js/sdk';
-/**
- * `useDocument` is a custom hook that returns the root object of the document.
- *
- * @param publicAPIKey
- * @param docKey
- * @param initialRoot
- * @returns
- */
-export function useDocument(publicAPIKey, docKey, initialRoot, options) {
-    const [client, setClient] = useState(undefined);
-    const [doc, setDoc] = useState(undefined);
-    const [root, setRoot] = useState(initialRoot);
-    const [loading, setLoading] = useState(true);
-    const [error, setError] = useState(undefined);
-    useEffect(() => {
-        setLoading(true);
-        setError(undefined);
-        /**
-         * `setupYorkie` initializes the Yorkie client and attaches the document.
-         */
-        async function setupYorkie() {
-            try {
-                const client = new Client(options?.rpcAddr || 'https://api.yorkie.dev', { apiKey: publicAPIKey });
-                await client.activate();
-                const doc = new Document(docKey);
-                await client.attach(doc, {
-                    initialPresence: {},
-                    initialRoot,
-                });
-                doc.subscribe((event) => {
-                    if (event.type === 'remote-change' || event.type === 'local-change') {
-                        setRoot(doc.getRoot());
-                    }
-                });
-                setClient(client);
-                setDoc(doc);
-                setRoot(doc.getRoot());
-            }
-            catch (err) {
-                setError(err instanceof Error ? err : new Error('Unknown error'));
-            }
-            finally {
-                setLoading(false);
-            }
-        }
-        setupYorkie();
-        return () => {
-            client?.deactivate({ keepalive: true });
-        };
-    }, [
-        publicAPIKey,
-        docKey,
-        JSON.stringify(initialRoot),
-        JSON.stringify(options),
-    ]);
-    const update = useCallback((callback) => {
-        if (!doc) {
-            console.warn('Attempted to update document before it was initialized');
-            return;
-        }
-        doc.update((root) => {
-            callback(root);
-        });
-    }, [doc]);
-    return {
-        root,
-        update,
-        loading,
-        error,
-    };
-}

package/src/index.ts

@@ -1,21 +0,0 @@
-/*
- * Copyright 2025 The Yorkie Authors. All rights reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import type { JSONArray, JSONObject } from '@yorkie-js/sdk';
-import { useDocument } from './useDocument';
-
-export { useDocument };
-export type { JSONArray, JSONObject };

package/src/useDocument.ts

@@ -1,116 +0,0 @@
-/*
- * Copyright 2025 The Yorkie Authors. All rights reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import { useCallback, useEffect, useState } from 'react';
-import { Client, Document } from '@yorkie-js/sdk';
-
-/**
- * `useDocument` is a custom hook that returns the root object of the document.
- *
- * @param publicAPIKey
- * @param docKey
- * @param initialRoot
- * @returns
- */
-export function useDocument<T>(
-  publicAPIKey: string,
-  docKey: string,
-  initialRoot: T,
-  options?: {
-    rpcAddr?: string;
-  },
-): {
-  root: T;
-  update: (callback: (root: T) => void) => void;
-  loading: boolean;
-  error: Error | undefined;
-} {
-  const [client, setClient] = useState<Client | undefined>(undefined);
-  const [doc, setDoc] = useState<Document<T> | undefined>(undefined);
-  const [root, setRoot] = useState<T>(initialRoot);
-  const [loading, setLoading] = useState<boolean>(true);
-  const [error, setError] = useState<Error | undefined>(undefined);
-
-  useEffect(() => {
-    setLoading(true);
-    setError(undefined);
-
-    /**
-     * `setupYorkie` initializes the Yorkie client and attaches the document.
-     */
-    async function setupYorkie() {
-      try {
-        const client = new Client(
-          options?.rpcAddr || 'https://api.yorkie.dev',
-          { apiKey: publicAPIKey },
-        );
-        await client.activate();
-
-        const doc = new Document<T>(docKey);
-        await client.attach(doc, {
-          initialPresence: {},
-          initialRoot,
-        });
-
-        doc.subscribe((event) => {
-          if (event.type === 'remote-change' || event.type === 'local-change') {
-            setRoot(doc.getRoot());
-          }
-        });
-
-        setClient(client);
-        setDoc(doc);
-        setRoot(doc.getRoot());
-      } catch (err) {
-        setError(err instanceof Error ? err : new Error('Unknown error'));
-      } finally {
-        setLoading(false);
-      }
-    }
-
-    setupYorkie();
-
-    return () => {
-      client?.deactivate({ keepalive: true });
-    };
-  }, [
-    publicAPIKey,
-    docKey,
-    JSON.stringify(initialRoot),
-    JSON.stringify(options),
-  ]);
-
-  const update = useCallback(
-    (callback: (root: T) => void) => {
-      if (!doc) {
-        console.warn('Attempted to update document before it was initialized');
-        return;
-      }
-
-      doc.update((root) => {
-        callback(root);
-      });
-    },
-    [doc],
-  );
-
-  return {
-    root,
-    update,
-    loading,
-    error,
-  };
-}

package/tsconfig.json

@@ -1,26 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2020",
-    "useDefineForClassFields": true,
-    "module": "ESNext",
-    "lib": ["ES2020", "DOM"],
-    "skipLibCheck": true,
-    "outDir": "./lib",
-
-    /* Bundler mode */
-    "moduleResolution": "node",
-    "allowSyntheticDefaultImports": true,
-    "resolveJsonModule": true,
-    "esModuleInterop": true,
-
-    /* Linting */
-    "strict": true,
-
-    /* Paths */
-    "baseUrl": ".",
-    "paths": {
-      "@yorkie-js-sdk/src/*": ["../../packages/sdk/src/*"]
-    }
-  },
-  "include": ["src"]
-}

package/vite.config.js

@@ -1,31 +0,0 @@
-import { defineConfig } from 'vite';
-import dts from 'vite-plugin-dts';
-import path from 'path';
-
-// https://vitejs.dev/config/
-export default defineConfig({
-  build: {
-    lib: {
-      entry: 'src/index.ts',
-      name: 'yorkie-js-react',
-      fileName: (format) =>
-        format === 'umd'
-          ? 'yorkie-js-react.js'
-          : `yorkie-js-react.${format}.js`,
-    },
-    outDir: 'dist',
-    sourcemap: true,
-    minify: false,
-    emptyOutDir: true,
-  },
-  resolve: {
-    alias: {
-      '@yorkie-js-sdk/src': path.resolve(__dirname, '../sdk/src'),
-    },
-  },
-  plugins: [
-    dts({
-      rollupTypes: true,
-    }),
-  ],
-});