ar_sync 1.0.1 → 1.0.2

data/src/core/DataType.ts

@@ -1,7 +1,8 @@
 type RecordType = { _meta?: { query: any } }
 type Values<T> = T extends { [K in keyof T]: infer U } ? U : never
-type DataTypeExtractField<BaseType, Key extends keyof BaseType> = BaseType[Key] extends RecordType
-  ? (null extends BaseType[Key] ? {} | null : {})
+type AddNullable<Test, Type> = null extends Test ? Type | null : Type
+type DataTypeExtractField<BaseType, Key extends keyof BaseType> = Exclude<BaseType[Key], null> extends RecordType
+  ? AddNullable<BaseType[Key], {}>
   : BaseType[Key] extends RecordType[]
   ? {}[]
   : BaseType[Key]
@@ -11,7 +12,7 @@ type DataTypeExtractFieldsFromQuery<BaseType, Fields> = '*' extends Fields
   : { [key in Fields & keyof (BaseType)]: DataTypeExtractField<BaseType, key> }
 
 interface ExtraFieldErrorType {
-  extraFieldError: any
+  error: 'extraFieldError';
 }
 
 type DataTypeExtractFromQueryHash<BaseType, QueryType> = '*' extends keyof QueryType
@@ -20,7 +21,7 @@ type DataTypeExtractFromQueryHash<BaseType, QueryType> = '*' extends keyof Query
         ? (key extends keyof QueryType
             ? (QueryType[key] extends true
                 ? DataTypeExtractField<BaseType, key>
-                : DataTypeFromQuery<BaseType[key] & {}, QueryType[key]>)
+                : AddNullable<BaseType[key], DataTypeFromQuery<BaseType[key] & {}, QueryType[key]>>)
             : DataTypeExtractField<BaseType, key>)
         : ExtraFieldErrorType)
     }
@@ -28,7 +29,7 @@ type DataTypeExtractFromQueryHash<BaseType, QueryType> = '*' extends keyof Query
       [key in keyof QueryType]: (key extends keyof BaseType
         ? (QueryType[key] extends true
             ? DataTypeExtractField<BaseType, key>
-            : DataTypeFromQuery<BaseType[key] & {}, QueryType[key]>)
+            : AddNullable<BaseType[key], DataTypeFromQuery<BaseType[key] & {}, QueryType[key]>>)
         : ExtraFieldErrorType)
     }
 
@@ -42,9 +43,7 @@ type _DataTypeFromQuery<BaseType, QueryType> = QueryType extends keyof BaseType
 
 export type DataTypeFromQuery<BaseType, QueryType> = BaseType extends any[]
   ? CheckAttributesField<BaseType[0], QueryType>[]
-  : null extends BaseType
-  ? CheckAttributesField<BaseType & {}, QueryType> | null
-  : CheckAttributesField<BaseType & {}, QueryType>
+  : AddNullable<BaseType, CheckAttributesField<BaseType & {}, QueryType>>
 
 type CheckAttributesField<P, Q> = Q extends { attributes: infer R }
   ? _DataTypeFromQuery<P, R>
@@ -52,22 +51,36 @@ type CheckAttributesField<P, Q> = Q extends { attributes: infer R }
 
 type IsAnyCompareLeftType = { __any: never }
 
-type CollectExtraFields<Type, Path> = ExtraFieldErrorType extends Type
-  ? (IsAnyCompareLeftType extends Type ? null : Path)
-  : _CollectExtraFields<Type extends (infer R)[] ? R : (Type extends object ? Type : null)>
-
-type _CollectExtraFields<Type> = keyof (Type) extends never
+type CollectExtraFields<Type, Path> =
+  IsAnyCompareLeftType extends Type
   ? null
-  : Values<{ [key in keyof Type]: CollectExtraFields<Type[key], [key]> }>
+  : Type extends ExtraFieldErrorType
+  ? Path
+  : Type extends (infer R)[]
+  ? _CollectExtraFields<R>
+  : _CollectExtraFields<Type>
+
+type _CollectExtraFields<Type> = Type extends object
+  ? (keyof (Type) extends never
+    ? null
+    : Values<{ [key in keyof Type]: CollectExtraFields<Type[key], key> }>
+  )
+  : null
 
 type SelectString<T> = T extends string ? T : never
-type _ValidateDataTypeExtraFileds<Extra, Type> = SelectString<Values<Extra>> extends never
+type _ValidateDataTypeExtraFileds<Extra, Type> = SelectString<Extra> extends never
   ? Type
-  : { error: { extraFields: SelectString<Values<Extra>> } }
+  : { error: { extraFields: SelectString<Extra> } }
 type ValidateDataTypeExtraFileds<Type> = _ValidateDataTypeExtraFileds<CollectExtraFields<Type, []>, Type>
 
-type RequestBase = { api: string; query: any; params?: any; _meta?: { data: any } }
-type DataTypeBaseFromRequestType<R> = R extends { _meta?: { data: infer DataType } } ? DataType : never
+type RequestBase = { api: string; query: any; id?: number; params?: any; _meta?: { data: any } }
+type DataTypeBaseFromRequestType<R extends RequestBase, ID> = R extends { _meta?: { data: infer DataType } }
+  ? (
+      ID extends number
+      ? ([DataType, R['params']] extends [(infer DT)[], { ids: number[] } | undefined] ? DT : never)
+      : DataType
+    )
+  : never
 export type DataTypeFromRequest<Req extends RequestBase, R extends RequestBase> = ValidateDataTypeExtraFileds<
-  DataTypeFromQuery<DataTypeBaseFromRequestType<Req>, R['query']>
->
+  DataTypeFromQuery<DataTypeBaseFromRequestType<Req, R['id']>, R['query']>
+>

data/src/core/hooks.ts

@@ -0,0 +1,108 @@
+import ArSyncAPI from './ArSyncApi'
+import ArSyncModel from './ArSyncModel'
+
+let useState: <T>(t: T | (() => T)) => [T, (t: T | ((t: T) => T)) => void]
+let useEffect: (f: (() => void) | (() => (() => void)), deps: any[]) => void
+let useMemo: <T>(f: () => T, deps: any[]) => T
+type InitializeHooksParams = {
+  useState: typeof useState
+  useEffect: typeof useEffect
+  useMemo: typeof useMemo
+}
+export function initializeHooks(hooks: InitializeHooksParams) {
+  useState = hooks.useState
+  useEffect = hooks.useEffect
+  useMemo = hooks.useMemo
+}
+function checkHooks() {
+  if (!useState) throw 'uninitialized. needs `initializeHooks({ useState, useEffect, useMemo })`'
+}
+
+interface ModelStatus { complete: boolean; notfound?: boolean; connected: boolean }
+export type DataAndStatus<T> = [T | null, ModelStatus]
+export interface Request { api: string; params?: any; query: any }
+
+const initialResult: DataAndStatus<any> = [null, { complete: false, notfound: undefined, connected: true }]
+export function useArSyncModel<T>(request: Request | null): DataAndStatus<T> {
+  checkHooks()
+  const [result, setResult] = useState<DataAndStatus<T>>(initialResult)
+  const requestString = JSON.stringify(request && request.params)
+  useEffect(() => {
+    if (!request) {
+      setResult(initialResult)
+      return () => {}
+    }
+    const model = new ArSyncModel<T>(request, { immutable: true })
+    function update() {
+      const { complete, notfound, connected, data } = model
+      setResult(resultWas => {
+        const [, statusWas] = resultWas
+        const statusPersisted = statusWas.complete === complete && statusWas.notfound === notfound && statusWas.connected === connected
+        const status = statusPersisted ? statusWas : { complete, notfound, connected }
+        return [data, status]
+      })
+    }
+    if (model.complete) {
+      update()
+    } else {
+      setResult(initialResult)
+    }
+    model.subscribe('change', update)
+    model.subscribe('connection', update)
+    return () => model.release()
+  }, [requestString])
+  return result
+}
+
+interface FetchStatus { complete: boolean; notfound?: boolean }
+type DataStatusUpdate<T> = [T | null, FetchStatus, () => void]
+type FetchState<T> = { data: T | null; status: FetchStatus }
+const initialFetchState: FetchState<any> = { data: null, status: { complete: false, notfound: undefined } }
+export function useArSyncFetch<T>(request: Request | null): DataStatusUpdate<T> {
+  checkHooks()
+  const [state, setState] = useState<FetchState<T>>(initialFetchState)
+  const requestString = JSON.stringify(request && request.params)
+  const loader = useMemo(() => {
+    let lastLoadId = 0
+    let timer: null | number = null
+    function cancel() {
+      if (timer) clearTimeout(timer)
+      timer = null
+      lastLoadId++
+    }
+    function fetch(request: Request, retryCount: number) {
+      cancel()
+      const currentLoadingId = lastLoadId
+      ArSyncAPI.fetch(request).then((response: T) => {
+        if (currentLoadingId !== lastLoadId) return
+        setState({ data: response, status: { complete: true, notfound: false } })
+      }).catch(e => {
+        if (currentLoadingId !== lastLoadId) return
+        if (!e.retry) {
+          setState({ data: null, status: { complete: true, notfound: true } })
+          return
+        }
+        timer = setTimeout(() => fetch(request, retryCount + 1), 1000 * Math.min(4 ** retryCount, 30))
+      })
+    }
+    function update() {
+      if (request) {
+        setState(state => {
+          const { data, status } = state
+          if (!status.complete && status.notfound === undefined) return state
+          return { data, status: { complete: false, notfound: undefined } }
+        })
+        fetch(request, 0)
+      } else {
+        setState(initialFetchState)
+      }
+    }
+    return { update, cancel }
+  }, [requestString])
+  useEffect(() => {
+    setState(initialFetchState)
+    loader.update()
+    return () => loader.cancel()
+  }, [requestString])
+  return [state.data, state.status, loader.update]
+}

data/src/index.ts

@@ -0,0 +1,2 @@
+export { default as ArSyncModel } from './core/ArSyncModel'
+export { default as ArSyncApi } from './core/ArSyncApi'

data/vendor/assets/javascripts/{ar_sync_tree.js.erb → ar_sync.js.erb}

@@ -5,13 +5,12 @@
   <% require = -> (path) { path = File.dirname(__FILE__) + "/../../../#{path}"; depend_on path; File.read path } %>
   <%= require.call 'core/ArSyncApi.js' %>
   window.ArSyncAPI = exports.default
-  modules['../core/ArSyncApi'] = { default: exports.default }
+  modules['./ArSyncApi'] = { default: exports.default }
   <%= require.call 'core/ConnectionManager.js' %>
-  modules['../core/ConnectionManager'] = { default: exports.default }
-  <%= require.call 'core/ArSyncModelBase.js' %>
-  modules['../core/ArSyncModelBase'] = { default: exports.default }
-  <%= require.call 'tree/ArSyncStore.js' %>
+  modules['./ConnectionManager'] = { default: exports.default }
+  <%= require.call 'core/ArSyncStore.js' %>
   modules['./ArSyncStore'] = { default: exports.default }
-  <%= require.call 'tree/ArSyncModel.js' %>
-  window.ArSyncModel = ArSyncModel
+  <%= require.call 'core/ArSyncModel.js' %>
+  modules['./ArSyncModel'] = { default: exports.default }
+  window.ArSyncModel = exports.default
 }())

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar_sync
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - tompng
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-13 00:00:00.000000000 Z
+date: 2019-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -28,16 +28,16 @@ dependencies:
   name: ar_serializer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord-import
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ActiveRecord data synchronized with frontend DataStore
 email:
 - tomoyapenguin@gmail.com
@@ -101,24 +115,20 @@ files:
 - core/ActioncableAdapter.js
 - core/ArSyncApi.d.ts
 - core/ArSyncApi.js
-- core/ArSyncModelBase.d.ts
-- core/ArSyncModelBase.js
+- core/ArSyncModel.d.ts
+- core/ArSyncModel.js
+- core/ArSyncStore.d.ts
+- core/ArSyncStore.js
 - core/ConnectionAdapter.d.ts
 - core/ConnectionAdapter.js
 - core/ConnectionManager.d.ts
 - core/ConnectionManager.js
 - core/DataType.d.ts
 - core/DataType.js
-- core/hooksBase.d.ts
-- core/hooksBase.js
-- graph/ArSyncModel.d.ts
-- graph/ArSyncModel.js
-- graph/ArSyncStore.d.ts
-- graph/ArSyncStore.js
-- graph/hooks.d.ts
-- graph/hooks.js
-- graph/index.d.ts
-- graph/index.js
+- core/hooks.d.ts
+- core/hooks.js
+- index.d.ts
+- index.js
 - lib/ar_sync.rb
 - lib/ar_sync/class_methods.rb
 - lib/ar_sync/collection.rb
@@ -135,31 +145,16 @@ files:
 - package.json
 - src/core/ActioncableAdapter.ts
 - src/core/ArSyncApi.ts
-- src/core/ArSyncModelBase.ts
+- src/core/ArSyncModel.ts
+- src/core/ArSyncStore.ts
 - src/core/ConnectionAdapter.ts
 - src/core/ConnectionManager.ts
 - src/core/DataType.ts
-- src/core/hooksBase.ts
-- src/graph/ArSyncModel.ts
-- src/graph/ArSyncStore.ts
-- src/graph/hooks.ts
-- src/graph/index.ts
-- src/tree/ArSyncModel.ts
-- src/tree/ArSyncStore.ts
-- src/tree/hooks.ts
-- src/tree/index.ts
-- tree/ArSyncModel.d.ts
-- tree/ArSyncModel.js
-- tree/ArSyncStore.d.ts
-- tree/ArSyncStore.js
-- tree/hooks.d.ts
-- tree/hooks.js
-- tree/index.d.ts
-- tree/index.js
+- src/core/hooks.ts
+- src/index.ts
 - tsconfig.json
+- vendor/assets/javascripts/ar_sync.js.erb
 - vendor/assets/javascripts/ar_sync_actioncable_adapter.js.erb
-- vendor/assets/javascripts/ar_sync_graph.js.erb
-- vendor/assets/javascripts/ar_sync_tree.js.erb
 homepage: https://github.com/tompng/ar_sync
 licenses:
 - MIT

data/core/hooksBase.d.ts

@@ -1,29 +0,0 @@
-interface ModelStatus {
-    complete: boolean;
-    notfound?: boolean;
-    connected: boolean;
-}
-export declare type DataAndStatus<T> = [T | null, ModelStatus];
-export interface Request {
-    api: string;
-    params?: any;
-    query: any;
-}
-interface ArSyncModel<T> {
-    data: T | null;
-    complete: boolean;
-    connected: boolean;
-    notfound?: boolean;
-    release(): void;
-    subscribe(type: any, callback: any): any;
-}
-export declare function useArSyncModelWithClass<T>(modelClass: {
-    new <T>(req: Request, option?: any): ArSyncModel<T>;
-}, request: Request | null): DataAndStatus<T>;
-interface FetchStatus {
-    complete: boolean;
-    notfound?: boolean;
-}
-declare type DataAndStatusAndUpdater<T> = [T | null, FetchStatus, () => void];
-export declare function useArSyncFetch<T>(request: Request | null): DataAndStatusAndUpdater<T>;
-export {};

data/core/hooksBase.js

@@ -1,80 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const react_1 = require("react");
-const ArSyncApi_1 = require("./ArSyncApi");
-function useArSyncModelWithClass(modelClass, request) {
-    const [data, setData] = react_1.useState(null);
-    const [status, setStatus] = react_1.useState({ complete: false, connected: true });
-    const updateStatus = (complete, notfound, connected) => {
-        if (complete === status.complete || notfound === status.notfound || connected === status.notfound)
-            return;
-        setStatus({ complete, notfound, connected });
-    };
-    react_1.useEffect(() => {
-        if (!request)
-            return () => { };
-        const model = new modelClass(request, { immutable: true });
-        if (model.complete)
-            setData(model.data);
-        updateStatus(model.complete, model.notfound, model.connected);
-        model.subscribe('change', () => {
-            updateStatus(model.complete, model.notfound, model.connected);
-            setData(model.data);
-        });
-        model.subscribe('connection', () => {
-            updateStatus(model.complete, model.notfound, model.connected);
-        });
-        return () => model.release();
-    }, [JSON.stringify(request && request.params)]);
-    return [data, status];
-}
-exports.useArSyncModelWithClass = useArSyncModelWithClass;
-function useArSyncFetch(request) {
-    const [response, setResponse] = react_1.useState(null);
-    const [status, setStatus] = react_1.useState({ complete: false });
-    const requestString = JSON.stringify(request && request.params);
-    let canceled = false;
-    let timer = null;
-    const update = react_1.useCallback(() => {
-        if (!request) {
-            setStatus({ complete: false, notfound: undefined });
-            return () => { };
-        }
-        canceled = false;
-        timer = null;
-        const fetch = (count) => {
-            if (timer)
-                clearTimeout(timer);
-            timer = null;
-            ArSyncApi_1.default.fetch(request)
-                .then((response) => {
-                if (canceled)
-                    return;
-                setResponse(response);
-                setStatus({ complete: true, notfound: false });
-            })
-                .catch(e => {
-                if (canceled)
-                    return;
-                if (!e.retry) {
-                    setResponse(null);
-                    setStatus({ complete: true, notfound: true });
-                    return;
-                }
-                timer = setTimeout(() => fetch(count + 1), 1000 * Math.min(4 ** count, 30));
-            });
-        };
-        fetch(0);
-    }, [requestString]);
-    react_1.useEffect(() => {
-        update();
-        return () => {
-            canceled = true;
-            if (timer)
-                clearTimeout(timer);
-            timer = null;
-        };
-    }, [requestString]);
-    return [response, status, update];
-}
-exports.useArSyncFetch = useArSyncFetch;