ar_sync 1.0.1 → 1.0.2

data/core/DataType.d.ts

@@ -6,7 +6,8 @@ declare type RecordType = {
 declare type Values<T> = T extends {
     [K in keyof T]: infer U;
 } ? U : never;
-declare type DataTypeExtractField<BaseType, Key extends keyof BaseType> = BaseType[Key] extends RecordType ? (null extends BaseType[Key] ? {} | null : {}) : BaseType[Key] extends RecordType[] ? {}[] : BaseType[Key];
+declare type AddNullable<Test, Type> = null extends Test ? Type | null : Type;
+declare type DataTypeExtractField<BaseType, Key extends keyof BaseType> = Exclude<BaseType[Key], null> extends RecordType ? AddNullable<BaseType[Key], {}> : BaseType[Key] extends RecordType[] ? {}[] : BaseType[Key];
 declare type DataTypeExtractFieldsFromQuery<BaseType, Fields> = '*' extends Fields ? {
     [key in Exclude<keyof BaseType, '_meta'>]: DataTypeExtractField<BaseType, key>;
 } : {
@@ -16,45 +17,48 @@ interface ExtraFieldErrorType {
     error: 'extraFieldError';
 }
 declare type DataTypeExtractFromQueryHash<BaseType, QueryType> = '*' extends keyof QueryType ? {
-    [key in Exclude<(keyof BaseType) | (keyof QueryType), '_meta' | '_params' | '*'>]: (key extends keyof BaseType ? (key extends keyof QueryType ? (QueryType[key] extends true ? DataTypeExtractField<BaseType, key> : DataTypeFromQuery<BaseType[key] & {}, QueryType[key]>) : DataTypeExtractField<BaseType, key>) : ExtraFieldErrorType);
+    [key in Exclude<(keyof BaseType) | (keyof QueryType), '_meta' | '_params' | '*'>]: (key extends keyof BaseType ? (key extends keyof QueryType ? (QueryType[key] extends true ? DataTypeExtractField<BaseType, key> : AddNullable<BaseType[key], DataTypeFromQuery<BaseType[key] & {}, QueryType[key]>>) : DataTypeExtractField<BaseType, key>) : ExtraFieldErrorType);
 } : {
-    [key in keyof QueryType]: (key extends keyof BaseType ? (QueryType[key] extends true ? DataTypeExtractField<BaseType, key> : DataTypeFromQuery<BaseType[key] & {}, QueryType[key]>) : ExtraFieldErrorType);
+    [key in keyof QueryType]: (key extends keyof BaseType ? (QueryType[key] extends true ? DataTypeExtractField<BaseType, key> : AddNullable<BaseType[key], DataTypeFromQuery<BaseType[key] & {}, QueryType[key]>>) : ExtraFieldErrorType);
 };
 declare type _DataTypeFromQuery<BaseType, QueryType> = QueryType extends keyof BaseType | '*' ? DataTypeExtractFieldsFromQuery<BaseType, QueryType> : QueryType extends Readonly<(keyof BaseType | '*')[]> ? DataTypeExtractFieldsFromQuery<BaseType, Values<QueryType>> : QueryType extends {
     as: string;
 } ? {
     error: 'type for alias field is not supported';
 } | undefined : DataTypeExtractFromQueryHash<BaseType, QueryType>;
-export declare type DataTypeFromQuery<BaseType, QueryType> = BaseType extends any[] ? CheckAttributesField<BaseType[0], QueryType>[] : null extends BaseType ? CheckAttributesField<BaseType & {}, QueryType> | null : CheckAttributesField<BaseType & {}, QueryType>;
+export declare type DataTypeFromQuery<BaseType, QueryType> = BaseType extends any[] ? CheckAttributesField<BaseType[0], QueryType>[] : AddNullable<BaseType, CheckAttributesField<BaseType & {}, QueryType>>;
 declare type CheckAttributesField<P, Q> = Q extends {
     attributes: infer R;
 } ? _DataTypeFromQuery<P, R> : _DataTypeFromQuery<P, Q>;
 declare type IsAnyCompareLeftType = {
     __any: never;
 };
-declare type CollectExtraFields<Type, Path> = IsAnyCompareLeftType extends Type ? null : Type extends ExtraFieldErrorType ? Path : Type extends (infer R)[] ? _CollectExtraFields<R> : Type extends object ? _CollectExtraFields<Type> : null;
-declare type _CollectExtraFields<Type> = keyof (Type) extends never ? null : Values<{
-    [key in keyof Type]: CollectExtraFields<Type[key], [key]>;
-}>;
+declare type CollectExtraFields<Type, Path> = IsAnyCompareLeftType extends Type ? null : Type extends ExtraFieldErrorType ? Path : Type extends (infer R)[] ? _CollectExtraFields<R> : _CollectExtraFields<Type>;
+declare type _CollectExtraFields<Type> = Type extends object ? (keyof (Type) extends never ? null : Values<{
+    [key in keyof Type]: CollectExtraFields<Type[key], key>;
+}>) : null;
 declare type SelectString<T> = T extends string ? T : never;
-declare type _ValidateDataTypeExtraFileds<Extra, Type> = SelectString<Values<Extra>> extends never ? Type : {
+declare type _ValidateDataTypeExtraFileds<Extra, Type> = SelectString<Extra> extends never ? Type : {
     error: {
-        extraFields: SelectString<Values<Extra>>;
+        extraFields: SelectString<Extra>;
     };
 };
 declare type ValidateDataTypeExtraFileds<Type> = _ValidateDataTypeExtraFileds<CollectExtraFields<Type, []>, Type>;
 declare type RequestBase = {
     api: string;
     query: any;
+    id?: number;
     params?: any;
     _meta?: {
         data: any;
     };
 };
-declare type DataTypeBaseFromRequestType<R> = R extends {
+declare type DataTypeBaseFromRequestType<R extends RequestBase, ID> = R extends {
     _meta?: {
         data: infer DataType;
     };
-} ? DataType : never;
-export declare type DataTypeFromRequest<Req extends RequestBase, R extends RequestBase> = ValidateDataTypeExtraFileds<DataTypeFromQuery<DataTypeBaseFromRequestType<Req>, R['query']>>;
+} ? (ID extends number ? ([DataType, R['params']] extends [(infer DT)[], {
+    ids: number[];
+} | undefined] ? DT : never) : DataType) : never;
+export declare type DataTypeFromRequest<Req extends RequestBase, R extends RequestBase> = ValidateDataTypeExtraFileds<DataTypeFromQuery<DataTypeBaseFromRequestType<Req, R['id']>, R['query']>>;
 export {};

data/core/hooks.d.ts

@@ -0,0 +1,28 @@
+declare let useState: <T>(t: T | (() => T)) => [T, (t: T | ((t: T) => T)) => void];
+declare let useEffect: (f: (() => void) | (() => (() => void)), deps: any[]) => void;
+declare let useMemo: <T>(f: () => T, deps: any[]) => T;
+declare type InitializeHooksParams = {
+    useState: typeof useState;
+    useEffect: typeof useEffect;
+    useMemo: typeof useMemo;
+};
+export declare function initializeHooks(hooks: InitializeHooksParams): void;
+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;
+}
+export declare function useArSyncModel<T>(request: Request | null): DataAndStatus<T>;
+interface FetchStatus {
+    complete: boolean;
+    notfound?: boolean;
+}
+declare type DataStatusUpdate<T> = [T | null, FetchStatus, () => void];
+export declare function useArSyncFetch<T>(request: Request | null): DataStatusUpdate<T>;
+export {};

data/core/hooks.js

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const ArSyncApi_1 = require("./ArSyncApi");
+const ArSyncModel_1 = require("./ArSyncModel");
+let useState;
+let useEffect;
+let useMemo;
+function initializeHooks(hooks) {
+    useState = hooks.useState;
+    useEffect = hooks.useEffect;
+    useMemo = hooks.useMemo;
+}
+exports.initializeHooks = initializeHooks;
+function checkHooks() {
+    if (!useState)
+        throw 'uninitialized. needs `initializeHooks({ useState, useEffect, useMemo })`';
+}
+const initialResult = [null, { complete: false, notfound: undefined, connected: true }];
+function useArSyncModel(request) {
+    checkHooks();
+    const [result, setResult] = useState(initialResult);
+    const requestString = JSON.stringify(request && request.params);
+    useEffect(() => {
+        if (!request) {
+            setResult(initialResult);
+            return () => { };
+        }
+        const model = new ArSyncModel_1.default(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;
+}
+exports.useArSyncModel = useArSyncModel;
+const initialFetchState = { data: null, status: { complete: false, notfound: undefined } };
+function useArSyncFetch(request) {
+    checkHooks();
+    const [state, setState] = useState(initialFetchState);
+    const requestString = JSON.stringify(request && request.params);
+    const loader = useMemo(() => {
+        let lastLoadId = 0;
+        let timer = null;
+        function cancel() {
+            if (timer)
+                clearTimeout(timer);
+            timer = null;
+            lastLoadId++;
+        }
+        function fetch(request, retryCount) {
+            cancel();
+            const currentLoadingId = lastLoadId;
+            ArSyncApi_1.default.fetch(request).then((response) => {
+                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];
+}
+exports.useArSyncFetch = useArSyncFetch;

data/index.d.ts

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

data/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var ArSyncModel_1 = require("./core/ArSyncModel");
+exports.ArSyncModel = ArSyncModel_1.default;
+var ArSyncApi_1 = require("./core/ArSyncApi");
+exports.ArSyncApi = ArSyncApi_1.default;

data/lib/ar_sync.rb

@@ -1,22 +1,5 @@
 module ArSync
-  module GraphSync; end
-  module TreeSync; end
-  def self.use(mode, klass: ActiveRecord::Base)
-    case mode
-    when :tree
-      if klass.ancestors.include? ArSync::GraphSync
-        raise ArgumentError, 'already activated ArSync::GraphSync'
-      end
-      klass.include ArSync::TreeSync
-    when :graph
-      if klass.ancestors.include? ArSync::TreeSync
-        raise ArgumentError, 'already activated ArSync::TreeSync'
-      end
-      klass.include ArSync::GraphSync
-    else
-      raise ArgumentError, 'argument should be :tree or :graph'
-    end
-  end
+  module ModelBase; end
 end
 require 'ar_sync/version'
 require 'ar_sync/core'

data/lib/ar_sync/class_methods.rb

@@ -1,7 +1,7 @@
 require_relative 'field'
 require_relative 'collection'
 
-module ArSync::ClassMethodsBase
+module ArSync::ModelBase::ClassMethods
   def _sync_self?
     instance_variable_defined? '@_sync_self'
   end
@@ -30,89 +30,16 @@ module ArSync::ClassMethodsBase
     superclass._each_sync_child(&block) if superclass < ActiveRecord::Base
   end
 
-  def sync_parent(parent, inverse_of:, only_to: nil)
+  def sync_parent(parent, inverse_of:, only_to: nil, watch: nil)
     _initialize_sync_callbacks
     _sync_parents_info << [
       parent,
-      { inverse_name: inverse_of, only_to: only_to }
+      { inverse_name: inverse_of, only_to: only_to, watch: watch }
     ]
   end
-end
-
-module ArSync::TreeSync::ClassMethods
-  include ArSync::ClassMethodsBase
-  def sync_collection(name)
-    ArSync::Collection::Tree.find self, name
-  end
-
-  def sync_has_data(*names, **option, &original_data_block)
-    @_sync_self = true
-    option = option.dup
-    if original_data_block
-      data_block = ->(*args) { instance_exec(*args, &original_data_block).as_json }
-    end
-    option[:params_type] = {}
-    names.each do |name|
-      type_override = data_block.nil? && reflect_on_association(name.to_s.underscore) ? { type: :any } : {}
-      _sync_define ArSync::DataField.new(name), option.merge(type_override), &data_block
-    end
-  end
-
-  def sync_has_one(name, **option, &data_block)
-    _sync_define ArSync::HasOneField.new(name), option, &data_block
-  end
-
-  def sync_has_many(name, order: :asc, propagate_when: nil, params_type: nil, limit: nil, preload: nil, association: nil, **option, &data_block)
-    if data_block.nil? && preload.nil?
-      underscore_name = name.to_s.underscore.to_sym
-      preload = lambda do |records, _context, params|
-        ArSerializer::Field.preload_association(
-          self, records, association || underscore_name,
-          order: (!limit && params && params[:order]) || order,
-          limit: [params && params[:limit]&.to_i, limit].compact.min
-        )
-      end
-      data_block = lambda do |preloaded, _context, _params|
-        preloaded ? preloaded[id] || [] : send(name)
-      end
-      params_type = { limit?: :int, order?: [{ :* => %w[asc desc] }, 'asc', 'desc'] }
-    else
-      params_type = {}
-    end
-    field = ArSync::HasManyField.new name, association: association, order: order, limit: limit, propagate_when: propagate_when
-    _sync_define field, preload: preload, association: association, params_type: params_type, **option, &data_block
-  end
-
-  def _sync_define(info, **option, &data_block)
-    _initialize_sync_callbacks
-    _sync_children_info[info.name] = info
-    serializer_field info.name, **option, &data_block unless _serializer_field_info info.name
-    serializer_field info.name, **option, namespace: :sync, &data_block
-  end
-
-  def sync_define_collection(name, limit: nil, order: :asc)
-    _initialize_sync_callbacks
-    collection = ArSync::Collection::Tree.new self, name, limit: limit, order: order
-    sync_parent collection, inverse_of: [self, name]
-  end
-
-  def _initialize_sync_callbacks
-    return if instance_variable_defined? '@_sync_callbacks_initialized'
-    @_sync_callbacks_initialized = true
-    _sync_define ArSync::DataField.new(:id)
-    %i[create update destroy].each do |action|
-      after_commit on: action do
-        next if ArSync.skip_notification?
-        self.class.default_scoped.scoping { _sync_notify action }
-      end
-    end
-  end
-end
 
-module ArSync::GraphSync::ClassMethods
-  include ArSync::ClassMethodsBase
   def sync_collection(name)
-    ArSync::Collection::Graph.find self, name
+    ArSync::Collection.find self, name
   end
 
   def sync_has_data(*names, **option, &data_block)
@@ -153,22 +80,33 @@ module ArSync::GraphSync::ClassMethods
           limit: [params && params[:limit]&.to_i, limit].compact.min
         )
       end
+      serializer_data_block = lambda do |preloaded, _context, _params|
+        preloaded ? preloaded[id] || [] : send(name)
+      end
       params_type = { limit?: :int, order?: [{ :* => %w[asc desc] }, 'asc', 'desc'] }
     else
       params_type = {}
     end
-    _sync_define name, preload: preload, association: association, **option.merge(params_type: params_type), &data_block
-  end
-
-  def _sync_define(name, **option, &data_block)
+    _sync_define(
+      name,
+      serializer_data_block: serializer_data_block,
+      preload: preload,
+      association: association,
+      params_type: params_type,
+      **option,
+      &data_block
+    )
+  end
+
+  def _sync_define(name, serializer_data_block: nil, **option, &data_block)
     _initialize_sync_callbacks
-    serializer_field name, **option, &data_block unless _serializer_field_info name
+    serializer_field name, **option, &(serializer_data_block || data_block) unless _serializer_field_info name
     serializer_field name, **option, namespace: :sync, &data_block
   end
 
   def sync_define_collection(name, limit: nil, order: :asc)
     _initialize_sync_callbacks
-    collection = ArSync::Collection::Graph.new self, name, limit: limit, order: order
+    collection = ArSync::Collection.new self, name, limit: limit, order: order
     sync_parent collection, inverse_of: [self, name]
   end
 
@@ -176,8 +114,9 @@ module ArSync::GraphSync::ClassMethods
     return if instance_variable_defined? '@_sync_callbacks_initialized'
     @_sync_callbacks_initialized = true
     mod = Module.new do
-      def write_attribute(attr_name, value)
+      def _write_attribute(attr_name, value)
         self.class.default_scoped.scoping do
+          @_sync_watch_values_before_mutation ||= _sync_current_watch_values
           @_sync_parents_info_before_mutation ||= _sync_current_parents_info
           @_sync_belongs_to_info_before_mutation ||= _sync_current_belongs_to_info
         end
@@ -185,32 +124,35 @@ module ArSync::GraphSync::ClassMethods
       end
     end
     prepend mod
-    attr_reader :_sync_parents_info_before_mutation, :_sync_belongs_to_info_before_mutation
+    attr_reader :_sync_parents_info_before_mutation, :_sync_belongs_to_info_before_mutation, :_sync_watch_values_before_mutation
 
     _sync_define :id
 
     _sync_define :sync_keys, type: [:string] do |current_user|
-      ArSync.sync_graph_keys self, current_user
+      ArSync.sync_keys self, current_user
     end
 
     _sync_define :defaults, namespace: :sync do |current_user|
-      { sync_keys: ArSync.sync_graph_keys(self, current_user) }
+      { sync_keys: ArSync.sync_keys(self, current_user) }
     end
 
     before_destroy do
       @_sync_parents_info_before_mutation ||= _sync_current_parents_info
+      @_sync_watch_values_before_mutation ||= _sync_current_watch_values
       @_sync_belongs_to_info_before_mutation ||= _sync_current_belongs_to_info
     end
 
     before_save on: :create do
-      @_sync_parents_info_before_mutation ||= _sync_current_parents_info
-      @_sync_belongs_to_info_before_mutation ||= _sync_current_belongs_to_info
+      @_sync_parents_info_before_mutation ||= {}
+      @_sync_watch_values_before_mutation ||= {}
+      @_sync_belongs_to_info_before_mutation ||= {}
     end
 
     %i[create update destroy].each do |action|
       after_commit on: action do
         next if ArSync.skip_notification?
         self.class.default_scoped.scoping { _sync_notify action }
+        @_sync_watch_values_before_mutation = nil
         @_sync_parents_info_before_mutation = nil
         @_sync_belongs_to_info_before_mutation = nil
       end

data/lib/ar_sync/collection.rb

@@ -11,11 +11,6 @@ class ArSync::Collection
     define_singleton_method(name) { to_a }
   end
 
-  def sync_send_event(type:, to_user: nil, data:)
-    event_data = { type: type, data: data }
-    ArSync.sync_tree_send to: self, action: :event, path: [], data: event_data, to_user: to_user
-  end
-
   def to_a
     all = klass.all
     all = all.order id: order if order
@@ -30,35 +25,15 @@ class ArSync::Collection
   def self.find(klass, name)
     defined_collections[[klass, name]]
   end
-end
-
-class ArSync::Collection::Tree < ArSync::Collection
-  def initialize(*)
-    super
-    @field = ArSync::CollectionField.new @name, limit: @limit, order: @order
-    self.class._sync_children_info[[@klass, @name]] = @field
-  end
-
-  def _sync_notify_parent(*); end
-
-  def self._sync_children_info
-    @sync_children_info ||= {}
-  end
-
-  def self._sync_child_info(key)
-    _sync_children_info[key]
-  end
-end
 
-class ArSync::Collection::Graph < ArSync::Collection
-  def _sync_notify_child_changed(_child, _name, _to_user, _owned); end
+  def _sync_notify_child_changed(_name, _to_user); end
 
-  def _sync_notify_child_added(child, _name, to_user, _owned)
-    ArSync.sync_graph_send to: self, action: :add, model: child, path: :collection, to_user: to_user
+  def _sync_notify_child_added(child, _name, to_user)
+    ArSync.sync_send to: self, action: :add, model: child, path: :collection, to_user: to_user
   end
 
   def _sync_notify_child_removed(child, _name, to_user, _owned)
-    ArSync.sync_graph_send to: self, action: :remove, model: child, path: :collection, to_user: to_user
+    ArSync.sync_send to: self, action: :remove, model: child, path: :collection, to_user: to_user
   end
 
   def self._sync_children_info