@effijs/templates 0.0.0-stage → 1.0.0-alpha.0

package/platforms/react-native/solutions/services/firebase-core/README.md

@@ -0,0 +1,31 @@
+# Firebase core
+
+Resolves the default Firebase app.
+
+## API
+
+firebaseApp() returns the default Firebase app.
+
+## Example
+
+```tsx
+import { firebaseApp } from '@services/firebase';
+```
+
+## Dependencies
+
+- matrix key `firebase-app`
+
+No other solutions are required.
+
+## Manual steps
+
+- Download GoogleService-Info.plist and add it to the iOS app target.
+- Download google-services.json and place it in android/app.
+- Apply the Google services Gradle plugin in the Android build files.
+
+## Added in
+
+1.0.0 (`stable`).
+
+Install with `forge g add --id service:firebase-core`.

package/platforms/react-native/solutions/services/firebase-core/files/index.ts

@@ -0,0 +1,5 @@
+import { getApp, type ReactNativeFirebase } from '@react-native-firebase/app';
+
+export function firebaseApp(): ReactNativeFirebase.FirebaseApp {
+  return getApp();
+}

package/platforms/react-native/solutions/services/firebase-core/solution.js

@@ -0,0 +1,39 @@
+export default {
+  "id": "service:firebase-core",
+  "type": "service",
+  "platforms": [
+    "react-native"
+  ],
+  "title": "Firebase core",
+  "description": "Resolves the default Firebase app.",
+  "status": "stable",
+  "since": "1.0.0",
+  "tags": [
+    "service",
+    "firebase"
+  ],
+  "requires": [],
+  "dependencies": [
+    "firebase-app"
+  ],
+  "files": [
+    {
+      "from": "files",
+      "to": "services/firebase"
+    }
+  ],
+  "register": [
+    {
+      "file": "services/index.ts",
+      "marker": "services",
+      "code": "import '@services/firebase';\n"
+    }
+  ],
+  "manual": [
+    "Download GoogleService-Info.plist and add it to the iOS app target.",
+    "Download google-services.json and place it in android/app.",
+    "Apply the Google services Gradle plugin in the Android build files."
+  ],
+  "api": "firebaseApp() returns the default Firebase app.",
+  "example": "import { firebaseApp } from '@services/firebase';"
+};

package/platforms/react-native/solutions/services/firebase-messaging/README.md

@@ -0,0 +1,31 @@
+# Firebase messaging
+
+Requests notification permission and reads the FCM token.
+
+## API
+
+FirebaseMessagingService.token() and FirebaseMessagingService.listen().
+
+## Example
+
+```tsx
+EffiJS.resolve(FirebaseMessagingService).token()
+```
+
+## Dependencies
+
+- matrix key `firebase-messaging`
+
+Requires: `service:firebase-core`, `util:permissions`.
+
+## Manual steps
+
+- Enable Cloud Messaging in the Firebase console.
+- Upload the APNs authentication key for iOS.
+- On iOS, enable the Push Notifications capability.
+
+## Added in
+
+1.0.0 (`stable`).
+
+Install with `forge g add --id service:firebase-messaging`.

package/platforms/react-native/solutions/services/firebase-messaging/files/index.ts

@@ -0,0 +1,20 @@
+import { Entity } from '@effijs/common';
+import { getMessaging, getToken, onMessage } from '@react-native-firebase/messaging';
+
+import { firebaseApp } from '@services/firebase';
+import { requestNotificationPermission } from '@utils/permissions';
+
+@Entity.Decorators.Service()
+export class FirebaseMessagingService {
+  async token() {
+    const allowed = await requestNotificationPermission();
+    if (!allowed) return null;
+    return getToken(getMessaging(firebaseApp()));
+  }
+
+  listen(handler: (title?: string) => void) {
+    return onMessage(getMessaging(firebaseApp()), (message) => {
+      handler(message.notification?.title);
+    });
+  }
+}

package/platforms/react-native/solutions/services/firebase-messaging/solution.js

@@ -0,0 +1,42 @@
+export default {
+  "id": "service:firebase-messaging",
+  "type": "service",
+  "platforms": [
+    "react-native"
+  ],
+  "title": "Firebase messaging",
+  "description": "Requests notification permission and reads the FCM token.",
+  "status": "stable",
+  "since": "1.0.0",
+  "tags": [
+    "service",
+    "firebase"
+  ],
+  "requires": [
+    "service:firebase-core",
+    "util:permissions"
+  ],
+  "dependencies": [
+    "firebase-messaging"
+  ],
+  "files": [
+    {
+      "from": "files",
+      "to": "services/firebase-messaging"
+    }
+  ],
+  "register": [
+    {
+      "file": "services/index.ts",
+      "marker": "services",
+      "code": "import '@services/firebase-messaging';\n"
+    }
+  ],
+  "manual": [
+    "Enable Cloud Messaging in the Firebase console.",
+    "Upload the APNs authentication key for iOS.",
+    "On iOS, enable the Push Notifications capability."
+  ],
+  "api": "FirebaseMessagingService.token() and FirebaseMessagingService.listen().",
+  "example": "EffiJS.resolve(FirebaseMessagingService).token()"
+};

package/platforms/react-native/solutions/utils/permissions/README.md

@@ -0,0 +1,29 @@
+# Permissions
+
+Asks for notification permission on iOS and Android.
+
+## API
+
+requestNotificationPermission(): Promise<boolean>
+
+## Example
+
+```tsx
+const allowed = await requestNotificationPermission();
+```
+
+## Dependencies
+
+None beyond the setup baseline.
+
+No other solutions are required.
+
+## Manual steps
+
+None.
+
+## Added in
+
+1.0.0 (`stable`).
+
+Install with `forge g util --id util:permissions`.

package/platforms/react-native/solutions/utils/permissions/files/permissions.ts

@@ -0,0 +1,10 @@
+import { PermissionsAndroid, Platform } from 'react-native';
+
+export async function requestNotificationPermission(): Promise<boolean> {
+  if (Platform.OS === 'android') {
+    if (Platform.Version < 33) return true;
+    const result = await PermissionsAndroid.request(PermissionsAndroid.PERMISSIONS.POST_NOTIFICATIONS);
+    return result === PermissionsAndroid.RESULTS.GRANTED;
+  }
+  return true;
+}

package/platforms/react-native/solutions/utils/permissions/solution.js

@@ -0,0 +1,32 @@
+export default {
+  "id": "util:permissions",
+  "type": "util",
+  "platforms": [
+    "react-native"
+  ],
+  "title": "Permissions",
+  "description": "Asks for notification permission on iOS and Android.",
+  "status": "stable",
+  "since": "1.0.0",
+  "tags": [
+    "util"
+  ],
+  "requires": [],
+  "dependencies": [],
+  "files": [
+    {
+      "from": "files/permissions.ts",
+      "to": "utils/permissions.ts"
+    }
+  ],
+  "register": [
+    {
+      "file": "utils/index.ts",
+      "marker": "utils",
+      "code": "export { requestNotificationPermission } from './permissions';\n"
+    }
+  ],
+  "manual": [],
+  "api": "requestNotificationPermission(): Promise<boolean>",
+  "example": "const allowed = await requestNotificationPermission();"
+};

package/presets/react-native-fsd/index.js

@@ -0,0 +1,25 @@
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const generatorsDir = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../../platforms/react-native/generators');
+
+export default {
+  id: 'rn-fsd',
+  stack: 'react-native',
+  architecture: 'fsd',
+  platform: 'react-native',
+  templatesDir: generatorsDir,
+  outputDir: './src',
+  packageManager: 'yarn',
+  navigator: 'react-native-navigation',
+  generators: {
+    setup: { description: 'Install dependencies and patch React Native configs', path: 'setup' },
+    init: { description: 'Copy the FSD src base, auth, and the base UI kit', path: 'init' },
+    demo: { description: 'Add the product and category demo', path: 'demo' },
+    entity: { description: 'Entity layer (api, dto, service, store)', path: 'entity' },
+    feature: { description: 'Feature slice with selectable screens', path: 'feature' },
+    component: { description: 'props-manager UI component', path: 'component' },
+    add: { description: 'Install a ready-made component, service, or utility', path: 'add' },
+    util: { description: 'Install a utility', path: 'util' },
+  },
+};

package/shared/generators/entity/render.js

@@ -0,0 +1,88 @@
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+import { namesOf } from '../../../lib/names.js';
+
+const here = path.dirname(fileURLToPath(import.meta.url));
+
+export function entityTemplate(relative) {
+  return path.join(here, 'templates', relative);
+}
+
+export function parseFields(value) {
+  if (!value) return [];
+  return String(value)
+    .split(',')
+    .map((part) => part.trim())
+    .filter(Boolean)
+    .map((part) => {
+      const optional = part.includes('?');
+      const [name, type = 'string'] = part.replace('?', '').split(':');
+      return { name: name.trim(), type: type.trim(), optional };
+    });
+}
+
+function fieldLines(fields, { bang = false } = {}) {
+  return fields
+    .map((field) => {
+      const mark = field.optional || !bang ? '?' : '!';
+      return `  @Transform.Decorators.Property()\n  ${field.name}${mark}: ${field.type};`;
+    })
+    .join('\n\n');
+}
+
+function queryParamLines(fields) {
+  return fields
+    .map((field) => `    if (this.${field.name} !== undefined && this.${field.name} !== '') params.${field.name} = String(this.${field.name});`)
+    .join('\n');
+}
+
+export function prepareEntity(data) {
+  if (!data.name || !String(data.name).trim()) return 'Entity name is required. Pass --name.';
+  if (!['crud', 'simple'].includes(data.variant)) return `Unknown variant "${data.variant}"`;
+  const fields = parseFields(data.fields);
+  const props = fields.length ? fields : [{ name: 'title', type: 'string', optional: false }];
+  const queryFields = props.filter((field) => field.type === 'string' || field.type === 'number');
+  data.names = namesOf(data.name);
+  data.dataFieldLines = fieldLines(
+    [{ name: 'id', type: 'number', optional: false }, ...props.filter((field) => field.name !== 'id')],
+    { bang: true },
+  );
+  data.queryFieldLines = fieldLines(queryFields);
+  data.propFieldLines = fieldLines(props, { bang: true });
+  data.queryParamLines = queryParamLines(queryFields);
+  return null;
+}
+
+export function entityPrompts() {
+  return [
+    {
+      type: 'input',
+      name: 'name',
+      message: 'Entity name:',
+      validate: (input) => (input?.trim() ? true : 'Entity name is required'),
+    },
+    {
+      type: 'list',
+      name: 'variant',
+      message: 'Entity variant:',
+      choices: [
+        { name: 'crud (pagination, list and search)', value: 'crud' },
+        { name: 'simple (list only)', value: 'simple' },
+      ],
+      default: 'crud',
+    },
+    {
+      type: 'input',
+      name: 'apiUrl',
+      message: 'API resource path:',
+      default: (answers) => namesOf(answers.name).plural,
+    },
+    {
+      type: 'input',
+      name: 'fields',
+      message: 'Fields (title:string,price:number). Leave empty for a title field:',
+      default: '',
+    },
+  ];
+}

package/shared/generators/entity/templates/crud/api.ts.hbs

@@ -0,0 +1,36 @@
+import { Entity } from '@effijs/common';
+
+import { HttpBase } from '@services/http/http.base';
+
+import { {{names.pascal}}CreatePayload, {{names.pascal}}Data, {{names.pascal}}ListQueryParams, {{names.pascal}}UpdatePayload } from './{{names.kebab}}.dto';
+
+@Entity.Decorators.ApiService()
+export class {{names.pascal}}Api extends HttpBase {
+  protected url = '{{{apiUrl}}}';
+
+  list = (params?: Partial<{{names.pascal}}ListQueryParams>, options?: { signal?: AbortSignal }) =>
+    this.request(
+      { url: '', method: 'get', params, signal: options?.signal },
+      {
+        params: raw => {{names.pascal}}ListQueryParams.transform(raw).toQueryParams(),
+        response: raw => (Array.isArray(raw) ? raw.map(item => {{names.pascal}}Data.transform(item)) : []),
+      },
+    );
+
+  getById = (id: string, options?: { signal?: AbortSignal }) =>
+    this.request({ url: id, method: 'get', signal: options?.signal }, { response: raw => {{names.pascal}}Data.transform(raw) });
+
+  create = (payload: {{names.pascal}}CreatePayload, options?: { signal?: AbortSignal }) =>
+    this.request(
+      { url: '', method: 'post', data: payload, signal: options?.signal },
+      { data: raw => {{names.pascal}}CreatePayload.transform(raw), response: raw => {{names.pascal}}Data.transform(raw) },
+    );
+
+  update = (payload: {{names.pascal}}UpdatePayload, options?: { signal?: AbortSignal }) =>
+    this.request(
+      { url: `${payload.id}`, method: 'put', data: payload, signal: options?.signal },
+      { data: raw => {{names.pascal}}UpdatePayload.transform(raw), response: raw => {{names.pascal}}Data.transform(raw) },
+    );
+
+  delete = (id: string | number) => this.request({ url: `${id}`, method: 'delete' });
+}

package/shared/generators/entity/templates/crud/dto.ts.hbs

@@ -0,0 +1,36 @@
+import { Transform } from '@effijs/common';
+
+export class {{names.pascal}}Data extends Transform.WithTransform {
+{{{dataFieldLines}}}
+}
+
+export class {{names.pascal}}ListQuery extends Transform.WithTransform {
+{{{queryFieldLines}}}
+}
+
+export class {{names.pascal}}ListQueryParams extends Transform.WithTransform {
+  @Transform.Decorators.Property()
+  offset?: number;
+
+  @Transform.Decorators.Property()
+  limit?: number;
+
+{{{queryFieldLines}}}
+
+  toQueryParams(): Record<string, string> {
+    const params: Record<string, string> = {};
+    if (this.offset !== undefined) params.offset = String(this.offset);
+    if (this.limit !== undefined) params.limit = String(this.limit);
+{{{queryParamLines}}}
+    return params;
+  }
+}
+
+export class {{names.pascal}}CreatePayload extends Transform.WithTransform {
+{{{propFieldLines}}}
+}
+
+export class {{names.pascal}}UpdatePayload extends {{names.pascal}}CreatePayload {
+  @Transform.Decorators.Property()
+  id!: number;
+}

package/shared/generators/entity/templates/crud/service.ts.hbs

@@ -0,0 +1,73 @@
+import { Entity, Pagination } from '@effijs/common';
+
+import { {{names.pascal}}Api } from './{{names.kebab}}.api';
+import { {{names.pascal}}CreatePayload, {{names.pascal}}Data, {{names.pascal}}ListQuery, {{names.pascal}}UpdatePayload } from './{{names.kebab}}.dto';
+import { {{names.pascal}}IdsIndex, {{names.pascal}}Store } from './{{names.kebab}}.store';
+
+export type { {{names.pascal}}IdsIndex } from './{{names.kebab}}.store';
+
+@Entity.Decorators.Service()
+export class {{names.pascal}}Service {
+  pagination: Record<{{names.pascal}}IdsIndex, Pagination.OffsetPagination>;
+
+  constructor(private api: {{names.pascal}}Api, readonly store: {{names.pascal}}Store) {
+    this.pagination = {
+      list: new Pagination.OffsetPagination(this.store, 'list', { limit: 20, offset: 0 }),
+      search: new Pagination.OffsetPagination(this.store, 'search', { limit: 20, offset: 0 }),
+    };
+  }
+
+  getById = (id: string) => this.store.getByPath(`{{names.kebab}}.${String(id)}`) as {{names.pascal}}Data | undefined;
+
+  getListIds = (index: {{names.pascal}}IdsIndex = 'list') => (this.store.getByPath(`ids.${index}`) as string[] | undefined) ?? [];
+
+  getQuery = (index: {{names.pascal}}IdsIndex): {{names.pascal}}ListQuery =>
+    (this.store.getByPath(`query.${index}`) as {{names.pascal}}ListQuery | undefined) ?? {};
+
+  setQuery = (index: {{names.pascal}}IdsIndex, params?: Record<string, unknown>) => {
+    this.store.set(`query.${index}`, {{names.pascal}}ListQuery.transform(params));
+  };
+
+  async fetchList(index: {{names.pascal}}IdsIndex = 'list', options?: { signal?: AbortSignal; mode?: Pagination.ListMergeMode }) {
+    const mode = options?.mode ?? 'replace';
+    const slot = this.pagination[index];
+    if (mode === 'replace') slot.reset();
+    else if (!slot.hasMore) return [];
+    const { data } = await this.api.list({ ...this.getQuery(index), ...slot.params() }, { signal: options?.signal });
+    slot.apply({ items: data });
+    slot.next();
+    const incoming = data.map(item => {
+      this.store.set(`{{names.kebab}}.${String(item.id)}`, item);
+      return String(item.id);
+    });
+    this.store.set(`ids.${index}`, Pagination.mergeIds(this.getListIds(index), incoming, mode));
+    return data;
+  }
+
+  async fetchById(id: string, options?: { force?: boolean; signal?: AbortSignal }) {
+    if (!options?.force) {
+      const cached = this.getById(id);
+      if (cached) return cached;
+    }
+    const { data } = await this.api.getById(id, { signal: options?.signal });
+    this.store.set(`{{names.kebab}}.${String(data.id)}`, data);
+    return data;
+  }
+
+  async create(payload: {{names.pascal}}CreatePayload) {
+    const { data } = await this.api.create(payload);
+    this.store.set(`{{names.kebab}}.${String(data.id)}`, data);
+    return data;
+  }
+
+  async update(payload: {{names.pascal}}UpdatePayload) {
+    const { data } = await this.api.update(payload);
+    this.store.set(`{{names.kebab}}.${String(data.id)}`, data);
+    return data;
+  }
+
+  async remove(id: string | number) {
+    await this.api.delete(id);
+    this.store.delete(`{{names.kebab}}.${String(id)}`);
+  }
+}

package/shared/generators/entity/templates/crud/store.ts.hbs

@@ -0,0 +1,27 @@
+import { Entity, Pagination, Store } from '@effijs/common';
+
+import { StoreRegistry } from '@utils';
+
+import { {{names.pascal}}Data, {{names.pascal}}ListQuery } from './{{names.kebab}}.dto';
+
+export type {{names.pascal}}IdsIndex = 'list' | 'search';
+
+export type {{names.pascal}}StoreState = {
+  {{names.kebab}}: Record<string, {{names.pascal}}Data>;
+  ids: Record<{{names.pascal}}IdsIndex, string[]>;
+  pagination: Record<{{names.pascal}}IdsIndex, Pagination.OffsetState | undefined>;
+  query: Record<{{names.pascal}}IdsIndex, {{names.pascal}}ListQuery>;
+};
+
+@Entity.Decorators.Store()
+export class {{names.pascal}}Store extends Store.Common<{{names.pascal}}StoreState> {
+  constructor(private registry: StoreRegistry) {
+    super({
+      {{names.kebab}}: {},
+      ids: { list: [], search: [] },
+      pagination: { list: undefined, search: undefined },
+      query: { list: {}, search: {} },
+    });
+    registry.register(this);
+  }
+}

package/shared/generators/entity/templates/index.ts.hbs

@@ -0,0 +1,2 @@
+import './{{names.kebab}}.api';
+import './{{names.kebab}}.service';

package/shared/generators/entity/templates/simple/api.ts.hbs

@@ -0,0 +1,16 @@
+import { Entity } from '@effijs/common';
+
+import { HttpBase } from '@services/http/http.base';
+
+import { {{names.pascal}}Data } from './{{names.kebab}}.dto';
+
+@Entity.Decorators.ApiService()
+export class {{names.pascal}}Api extends HttpBase {
+  protected url = '{{{apiUrl}}}';
+
+  list = (options?: { signal?: AbortSignal }) =>
+    this.request(
+      { url: '', method: 'get', signal: options?.signal },
+      { response: raw => (Array.isArray(raw) ? raw.map(item => {{names.pascal}}Data.transform(item)) : []) },
+    );
+}

package/shared/generators/entity/templates/simple/dto.ts.hbs

@@ -0,0 +1,5 @@
+import { Transform } from '@effijs/common';
+
+export class {{names.pascal}}Data extends Transform.WithTransform {
+{{{dataFieldLines}}}
+}

package/shared/generators/entity/templates/simple/service.ts.hbs

@@ -0,0 +1,26 @@
+import { Entity } from '@effijs/common';
+
+import { {{names.pascal}}Api } from './{{names.kebab}}.api';
+import { {{names.pascal}}Data } from './{{names.kebab}}.dto';
+import { {{names.pascal}}Store } from './{{names.kebab}}.store';
+
+const ENTITY_KEY = '{{names.kebab}}';
+
+@Entity.Decorators.Service()
+export class {{names.pascal}}Service {
+  constructor(private api: {{names.pascal}}Api, readonly store: {{names.pascal}}Store) {}
+
+  getById = (id: string | number) => this.store.getByPath(`${ENTITY_KEY}.${String(id)}`) as {{names.pascal}}Data | undefined;
+
+  getListIds = () => (this.store.getByPath('ids.list') as string[] | undefined) ?? [];
+
+  async fetchList(options?: { signal?: AbortSignal }) {
+    const { data } = await this.api.list({ signal: options?.signal });
+    const ids = data.map(item => {
+      this.store.set(`${ENTITY_KEY}.${String(item.id)}`, item);
+      return String(item.id);
+    });
+    this.store.set('ids.list', ids);
+    return data;
+  }
+}

package/shared/generators/entity/templates/simple/store.ts.hbs

@@ -0,0 +1,18 @@
+import { Entity, Store } from '@effijs/common';
+
+import { StoreRegistry } from '@utils';
+
+import { {{names.pascal}}Data } from './{{names.kebab}}.dto';
+
+export type {{names.pascal}}StoreState = {
+  {{names.kebab}}: Record<string, {{names.pascal}}Data>;
+  ids: { list: string[] };
+};
+
+@Entity.Decorators.Store()
+export class {{names.pascal}}Store extends Store.Common<{{names.pascal}}StoreState> {
+  constructor(private registry: StoreRegistry) {
+    super({ {{names.kebab}}: {}, ids: { list: [] } });
+    registry.register(this);
+  }
+}

package/shared/solutions/utils/date/README.md

@@ -0,0 +1,29 @@
+# Date
+
+Pure date helpers. init already copies this file for React Native.
+
+## API
+
+Helpers exported from utils/date.ts.
+
+## Example
+
+```tsx
+import * as date from '@utils/date';
+```
+
+## Dependencies
+
+None beyond the setup baseline.
+
+No other solutions are required.
+
+## Manual steps
+
+None.
+
+## Added in
+
+1.0.0 (`stable`).
+
+Install with `forge g util --id util:date`.

package/shared/solutions/utils/date/files/date.ts

@@ -0,0 +1,11 @@
+import dayjs from 'dayjs';
+
+export function dayjsInstance() {
+  return dayjs();
+}
+
+export function format(date: Date | string, pattern = 'YYYY-MM-DD') {
+  return dayjs(date).format(pattern);
+}
+
+export { dayjs };