@roko-app/instant-react-native 0.0.0-stage → 1.0.67-roko.2

package/src/Storage.native.ts

@@ -0,0 +1,91 @@
+import { StoreInterface, StoreInterfaceStoreName } from '@instantdb/core';
+
+const version = 5;
+
+// AsyncStorage is an optional peer dependency. The `require` must sit
+// directly inside a `try` block: that's what makes Metro treat it as an
+// optional dependency (`transformer.allowOptionalDependencies`, enabled by
+// default in the Expo and React Native metro configs), so bundling doesn't
+// fail when it isn't installed. When it can't be loaded, `init` surfaces a
+// helpful error unless a custom `Store` is passed.
+let AsyncStorage: any = null;
+let asyncStorageLoadError: unknown = null;
+try {
+  AsyncStorage = require('@react-native-async-storage/async-storage').default;
+} catch (e) {
+  asyncStorageLoadError = e;
+}
+
+export class AsyncStorageStore extends StoreInterface {
+  private appId: string;
+  private dbName: StoreInterfaceStoreName;
+  constructor(appId: string, dbName: StoreInterfaceStoreName) {
+    super(appId, dbName);
+    this.appId = appId;
+    this.dbName = dbName;
+  }
+
+  private makeKey(k: string): string {
+    return `instant_${this.appId}_${version}_${this.dbName}_${k}`;
+  }
+
+  async getItem(k) {
+    const res = await AsyncStorage.getItem(this.makeKey(k));
+    if (res === null) return res;
+    return JSON.parse(res);
+  }
+
+  async setItem(k, v) {
+    await AsyncStorage.setItem(this.makeKey(k), JSON.stringify(v));
+  }
+
+  async removeItem(k: string): Promise<void> {
+    await AsyncStorage.removeItem(this.makeKey(k));
+  }
+
+  async getAllKeys(): Promise<string[]> {
+    const allKeys = await AsyncStorage.getAllKeys();
+    const keys: string[] = [];
+    const keyPrefix = this.makeKey('');
+    for (const key of allKeys) {
+      if (key.startsWith(keyPrefix)) {
+        keys.push(key.substring(keyPrefix.length));
+      }
+    }
+    return keys;
+  }
+
+  async multiSet(keyValuePairs: Array<[string, any]>): Promise<void> {
+    await AsyncStorage.multiSet(
+      keyValuePairs.map(([k, v]) => [this.makeKey(k), JSON.stringify(v)]),
+    );
+  }
+}
+
+class MissingStore extends StoreInterface {
+  constructor(appId: string, dbName: StoreInterfaceStoreName) {
+    super(appId, dbName);
+    throw new Error(
+      'Instant needs a store to persist data on device. ' +
+        'Install `@react-native-async-storage/async-storage`, ' +
+        'or pass a `Store` to `init` (e.g. from `@instantdb/react-native-mmkv` or `@instantdb/expo-sqlite`).' +
+        (asyncStorageLoadError
+          ? `\n\nLoading async-storage failed with: ${asyncStorageLoadError}`
+          : ''),
+    );
+  }
+
+  async getItem(_k: string): Promise<any> {
+    return null;
+  }
+
+  async removeItem(_k: string): Promise<void> {}
+
+  async multiSet(_keyValuePairs: Array<[string, any]>): Promise<void> {}
+
+  async getAllKeys(): Promise<string[]> {
+    return [];
+  }
+}
+
+export default AsyncStorage ? AsyncStorageStore : MissingStore;

package/src/Streams.native.ts

@@ -0,0 +1,6 @@
+import { ReadableStream, WritableStream } from 'web-streams-polyfill';
+
+export const streamConstructors = {
+  ReadableStream: ReadableStream,
+  WritableStream: WritableStream,
+};

package/src/Streams.ts

@@ -0,0 +1,5 @@
+// RN may need a polyfill for streams, so we put those in Streams.native.ts
+export const streamConstructors = {
+  ReadableStream: ReadableStream,
+  WritableStream: WritableStream,
+};

package/src/__types__/typeUtils.ts

@@ -0,0 +1,39 @@
+// Type testing utils from
+// https://github.com/type-challenges/type-challenges/blob/main/utils/index.d.ts
+
+export type Expect<T extends true> = T;
+export type ExpectTrue<T extends true> = T;
+export type ExpectFalse<T extends false> = T;
+export type IsTrue<T extends true> = T;
+export type IsFalse<T extends false> = T;
+
+export type Equal<X, Y> =
+  (<T>() => T extends X ? 1 : 2) extends <T>() => T extends Y ? 1 : 2
+    ? true
+    : false;
+export type NotEqual<X, Y> = true extends Equal<X, Y> ? false : true;
+
+// https://stackoverflow.com/questions/49927523/disallow-call-with-any/49928360#49928360
+export type IsAny<T> = 0 extends 1 & T ? true : false;
+export type NotAny<T> = true extends IsAny<T> ? false : true;
+
+export type Debug<T> = { [K in keyof T]: T[K] };
+export type MergeInsertions<T> = T extends object
+  ? { [K in keyof T]: MergeInsertions<T[K]> }
+  : T;
+
+export type Alike<X, Y> = Equal<MergeInsertions<X>, MergeInsertions<Y>>;
+
+export type ExpectExtends<VALUE, EXPECTED> = EXPECTED extends VALUE
+  ? true
+  : false;
+export type ExpectValidArgs<
+  FUNC extends (...args: any[]) => any,
+  ARGS extends any[],
+> = ARGS extends Parameters<FUNC> ? true : false;
+
+export type UnionToIntersection<U> = (
+  U extends any ? (k: U) => void : never
+) extends (k: infer I) => void
+  ? I
+  : never;

package/src/__types__/typesTests.ts

@@ -0,0 +1,86 @@
+import type { Equal, Expect, IsAny, NotAny } from './typeUtils';
+import { i, init } from '../index';
+
+const schema = i.schema({
+  entities: {
+    tbl: i.entity({
+      d: i.date().indexed(),
+      dOptional: i.date().optional(),
+    }),
+  },
+});
+
+function _testUseDatesTest() {
+  const db = init({
+    schema,
+    appId: '123',
+    useDateObjects: true,
+  });
+
+  const { data } = db.useQuery({ tbl: {} });
+  const item = data?.tbl[0];
+  if (item) {
+    type t = typeof item.d;
+    type _cases = [Expect<NotAny<t>>, Expect<Equal<t, Date>>];
+
+    type tOpt = typeof item.dOptional;
+    type _cases_2 = [
+      Expect<NotAny<tOpt>>,
+      Expect<Equal<tOpt, Date | undefined>>,
+    ];
+  }
+}
+
+function _testUseDatesFalseTest() {
+  const db = init({
+    schema,
+    appId: '123',
+    useDateObjects: false,
+  });
+
+  const { data } = db.useQuery({ tbl: {} });
+  const item = data?.tbl[0];
+  if (item) {
+    type t = typeof item.d;
+    type _cases = [Expect<NotAny<t>>, Expect<Equal<t, string | number>>];
+
+    type tOpt = typeof item.dOptional;
+    type _cases_2 = [
+      Expect<NotAny<tOpt>>,
+      Expect<Equal<tOpt, string | number | undefined>>,
+    ];
+  }
+}
+
+function _testUseDatesUndefinedTest() {
+  const db = init({
+    schema,
+    appId: '123',
+  });
+
+  const { data } = db.useQuery({ tbl: {} });
+  const item = data?.tbl[0];
+  if (item) {
+    type t = typeof item.d;
+    type _cases = [Expect<NotAny<t>>, Expect<Equal<t, string | number>>];
+
+    type tOpt = typeof item.dOptional;
+    type _cases_2 = [
+      Expect<NotAny<tOpt>>,
+      Expect<Equal<tOpt, string | number | undefined>>,
+    ];
+  }
+}
+
+function _testDataNoSchema() {
+  const db = init({
+    appId: '123',
+  });
+
+  const { data } = db.useQuery({ tbl: {} });
+  const item = data?.tbl[0];
+  if (item) {
+    type t = typeof item.d;
+    type _cases = [Expect<IsAny<t>>, Expect<Equal<typeof item.id, string>>];
+  }
+}

package/src/cli.ts

@@ -0,0 +1 @@
+export * from '@instantdb/core';

package/src/index.ts

@@ -0,0 +1,290 @@
+import 'react-native-get-random-values';
+
+import Store from './Storage';
+import EventSourceImpl from './EventSourceImpl';
+import NetworkListener from './NetworkListener';
+import version from './version';
+import { streamConstructors } from './Streams';
+
+import { InstantReactAbstractDatabase } from '@instantdb/react-common';
+
+import {
+  i,
+  id,
+  tx,
+  lookup,
+  // error
+  InstantAPIError,
+  setInstantWarningsEnabled,
+
+  // sync table enums
+  SyncTableCallbackEventType,
+
+  // types
+  createInstantRouteHandler,
+  type RoomSchemaShape,
+  type InstantQuery,
+  type InstantQueryResult,
+  type InstantSchema,
+  type InstantSchemaDatabase,
+  type ConnectionStatus,
+  type BackwardsCompatibleSchema,
+  type IInstantDatabase,
+  type Config,
+  type Query,
+  type QueryResponse,
+  type InstantObject,
+  type AuthState,
+  type User,
+
+  // presence types
+  type PresencePeer,
+
+  // schema types
+  type AttrsDefs,
+  type CardinalityKind,
+  type DataAttrDef,
+  type EntitiesDef,
+  type EntitiesWithLinks,
+  type EntityDef,
+  type InstantGraph,
+  type InstantUnknownSchemaDef,
+  type LinkAttrDef,
+  type LinkDef,
+  type LinksDef,
+  type ResolveAttrs,
+  type ValueTypes,
+  type InstantEntity,
+  type ConfigWithSchema,
+  type InstaQLEntity,
+  type InstaQLResult,
+  type InstaQLEntitySubquery,
+  type RoomsOf,
+  type RoomsDef,
+  type PresenceOf,
+  type TopicsOf,
+  type TopicOf,
+  type RoomHandle,
+  type CreateParams,
+  type InstantConfig,
+  type InstantSchemaDef,
+  type InstantUnknownSchema,
+  type TransactionChunk,
+  type InstantRules,
+  type UpdateParams,
+  type LinkParams,
+  type ValidQuery,
+  type CheckMagicCodeParams,
+  type CheckMagicCodeResponse,
+  type ExchangeCodeForTokenParams,
+  type SendMagicCodeParams,
+  type SendMagicCodeResponse,
+  type SignInWithIdTokenParams,
+  type VerifyMagicCodeParams,
+  type VerifyResponse,
+
+  // storage types
+  type FileOpts,
+  type UploadFileResponse,
+  type DeleteFileResponse,
+
+  // sync table types
+  type SyncTableCallback,
+  type SyncTableCallbackEvent,
+  type SyncTableInitialSyncBatch,
+  type SyncTableInitialSyncComplete,
+  type SyncTableSyncTransaction,
+  type SyncTableLoadFromStorage,
+  type SyncTableSetupError,
+  StoreInterface,
+  type StoreInterfaceStoreName,
+  CreateReadStreamOpts,
+  CreateWriteStreamOpts,
+  InstantWritableStream,
+  InstantReadableStream,
+  type Logger,
+} from '@instantdb/core';
+
+/**
+ *
+ * The first step: init your application!
+ *
+ * Visit https://instantdb.com/dash to get your `appId` :)
+ *
+ * @example
+ *  import { init } from "@instantdb/react-native"
+ *
+ *  const db = init({ appId: "my-app-id" })
+ *
+ *  // You can also provide a schema for type safety and editor autocomplete!
+ *
+ *  import { init } from "@instantdb/react-native"
+ *  import schema from ""../instant.schema.ts";
+ *
+ *  const db = init({ appId: "my-app-id", schema })
+ *
+ *  // To learn more: https://instantdb.com/docs/modeling-data
+ */
+function init<
+  Schema extends InstantSchemaDef<any, any, any> = InstantUnknownSchema,
+  UseDates extends boolean = false,
+>(
+  // Allows config with missing `useDateObjects`, but keeps `UseDates`
+  // as a non-nullable in the InstantConfig type.
+  config: Omit<InstantConfig<Schema, UseDates>, 'useDateObjects'> & {
+    useDateObjects?: UseDates;
+  },
+): InstantReactNativeDatabase<
+  Schema,
+  UseDates,
+  InstantConfig<Schema, UseDates>
+> {
+  const configStrict = {
+    ReadableStream: streamConstructors.ReadableStream,
+    WritableStream: streamConstructors.WritableStream,
+    ...config,
+    useDateObjects: (config.useDateObjects ?? false) as UseDates,
+  };
+  return new InstantReactNativeDatabase<
+    Schema,
+    UseDates,
+    InstantConfig<Schema, UseDates>
+  >(configStrict, {
+    '@instantdb/react': version,
+  });
+}
+
+/**
+ * @deprecated
+ * `init_experimental` is deprecated. You can replace it with `init`.
+ *
+ * @example
+ *
+ * // Before
+ * import { init_experimental } from "@instantdb/react-native"
+ * const db = init_experimental({  ...  });
+ *
+ * // After
+ * import { init } from "@instantdb/react-native"
+ * const db = init({ ...  });
+ */
+const init_experimental = init;
+
+class InstantReactNativeDatabase<
+  Schema extends InstantSchemaDef<any, any, any>,
+  UseDates extends boolean,
+  Config extends InstantConfig<Schema, UseDates> = InstantConfig<
+    Schema,
+    UseDates
+  >,
+> extends InstantReactAbstractDatabase<Schema, UseDates, Config> {
+  static Store = Store;
+  static NetworkListener = NetworkListener;
+  static EventSourceImpl = EventSourceImpl;
+}
+
+export {
+  init,
+  init_experimental,
+  id,
+  tx,
+  lookup,
+  i,
+  createInstantRouteHandler,
+  InstantReactNativeDatabase,
+
+  // error
+  InstantAPIError,
+  setInstantWarningsEnabled,
+
+  // sync table enums
+  SyncTableCallbackEventType,
+
+  // types
+  type Config,
+  type Query,
+  type QueryResponse,
+  type InstantObject,
+  type User,
+  type AuthState,
+  type ConnectionStatus,
+  type InstantQuery,
+  type InstantQueryResult,
+  type InstantSchema,
+  type InstantSchemaDatabase,
+  type IInstantDatabase,
+  type InstantEntity,
+  type RoomSchemaShape,
+
+  // presence types
+  type PresencePeer,
+
+  // schema types
+  type AttrsDefs,
+  type CardinalityKind,
+  type DataAttrDef,
+  type EntitiesDef,
+  type EntitiesWithLinks,
+  type EntityDef,
+  type InstantGraph,
+  type CreateParams,
+  type LinkAttrDef,
+  type InstantConfig,
+  type LinkDef,
+  type InstantUnknownSchemaDef,
+  type LinksDef,
+  type RoomsOf,
+  type RoomsDef,
+  type RoomHandle,
+  type PresenceOf,
+  type TopicsOf,
+  type TopicOf,
+  type ResolveAttrs,
+  type ValueTypes,
+  type InstaQLEntity,
+  type InstaQLResult,
+  type InstaQLEntitySubquery,
+  type InstantSchemaDef,
+  type InstantUnknownSchema,
+  type BackwardsCompatibleSchema,
+  type InstantRules,
+  type UpdateParams,
+  type LinkParams,
+  type ValidQuery,
+  type CheckMagicCodeParams,
+  type CheckMagicCodeResponse,
+  type ExchangeCodeForTokenParams,
+  type SendMagicCodeParams,
+  type TransactionChunk,
+  type SendMagicCodeResponse,
+  type SignInWithIdTokenParams,
+  type VerifyMagicCodeParams,
+  type VerifyResponse,
+
+  // storage types
+  type FileOpts,
+  type UploadFileResponse,
+  type DeleteFileResponse,
+
+  // stream types
+  type CreateReadStreamOpts,
+  type CreateWriteStreamOpts,
+  type InstantWritableStream,
+  type InstantReadableStream,
+
+  // custom store
+  StoreInterface,
+  type StoreInterfaceStoreName,
+
+  // sync table types
+  type SyncTableCallback,
+  type SyncTableCallbackEvent,
+  type SyncTableInitialSyncBatch,
+  type SyncTableInitialSyncComplete,
+  type SyncTableSyncTransaction,
+  type SyncTableLoadFromStorage,
+  type SyncTableSetupError,
+
+  // logger
+  type Logger,
+};

package/src/version.ts

@@ -0,0 +1,3 @@
+import { version } from '@instantdb/version';
+
+export default version;

package/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "include": ["src"],
+  "exclude": ["node_modules", "dist", "src/__types__"],
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src",
+    "strictNullChecks": true
+  }
+}

package/tsconfig.module.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig",
+  "compilerOptions": {
+    "module": "es2015",
+    "moduleResolution": "node",
+    "outDir": "dist/module"
+  }
+}

package/tsconfig.test.json

@@ -0,0 +1,5 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["src", "src/__types__"],
+  "exclude": ["node_modules", "dist"]
+}