{"id":21611714,"url":"https://github.com/ktsstudio/mediaproject-stores","last_synced_at":"2025-07-17T06:32:18.937Z","repository":{"id":42694637,"uuid":"442411907","full_name":"ktsstudio/mediaproject-stores","owner":"ktsstudio","description":null,"archived":false,"fork":false,"pushed_at":"2024-02-22T09:26:01.000Z","size":145,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-04-23T17:32:43.812Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ktsstudio.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-12-28T09:20:35.000Z","updated_at":"2024-06-24T08:42:40.265Z","dependencies_parsed_at":"2023-11-21T14:26:40.669Z","dependency_job_id":"75bd456a-77a8-4029-aa4a-35b32c1c29f7","html_url":"https://github.com/ktsstudio/mediaproject-stores","commit_stats":{"total_commits":30,"total_committers":4,"mean_commits":7.5,"dds":0.5,"last_synced_commit":"62b79996f33539eb5afa3950b933275a3576b7c1"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ktsstudio%2Fmediaproject-stores","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ktsstudio%2Fmediaproject-stores/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ktsstudio%2Fmediaproject-stores/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ktsstudio%2Fmediaproject-stores/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ktsstudio","download_url":"https://codeload.github.com/ktsstudio/mediaproject-stores/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225855965,"owners_count":17534967,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-24T21:13:38.971Z","updated_at":"2024-11-24T21:13:39.533Z","avatar_url":"https://github.com/ktsstudio.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![kts](./logo.png)\n\n# @ktsstudio/mediaproject-stores\n\nПакет с базовыми MobX-сторами для медиапроектов.\n\n## Использование\n\n`npm install @ktsstudio/mediaproject-stores`\n\n`yarn add @ktsstudio/mediaproject-stores`\n\n## Модели\n\n### SubStoreModel\n\nМодель базового стора. Такой стор должен находиться внутри RootStore. Принимает в конструкторе ссылку на RootStore, хранит ее в поле `rootStore` для обращения к полям главного стора (например, для чтения из него эндпоинтов API через `this.rootStore.endpoints`). Пример использования приведен ниже.\n\n```typescript\nimport { SubStoreModel } from '@ktsstudio/mediaproject-stores';\nimport { action, makeObservable, observable } from 'mobx';\n\nimport RootStore from './RootStore';\n\nexport default class MySubStore extends SubStoreModel\u003cRootStore\u003e {\n  data: DataType | null = null;\n\n  constructor(rootStore: RootStore) {\n    super(rootStore);\n\n    makeObservable(this, {\n      data: observable,\n    });\n  }\n}\n```\n\n### MetaModel\n\nМодель для контроля состояния загрузки.\n\n### ApiListModel\n\nМодель предназначена для работы со списками, которые загружаются с сервера.\nПредоставляет методы для загрузки данных с сервера с оффсетом или пагинацией, контроля состояния загрузки, сброса данных.\nПри достижении конца списка, модель устанавливает флаг, что список загружен.\n\n### MockApiListModel\n\nМодель расширяет ApiListModel, добавляя возможность работы с мокапами.\n\n### PollingModel\n\nМодель, которая раз в заданное количество времени вызывает callback-функцию.\n\n### BlurAndFocusHandlerModel\n\nМодель для добавления обработчиков на блюр и фокус окна.\n\n### BaseTimerModel\n\nАбстрактный класс для модели таймера.\n\n### TimerModel\n\nМодель таймера, который работает заданное количество секунд и по окончании работы вызывает callback-функцию.\n\n### FixedTimerModel\n\nМодель таймера, который отсчитывает время до заданной даты в секундах и по окончании вызывает callback-функцию.\n\n### FieldModel\n\nМодель для изменяемых полей классов.\n\n### ListModel\n\nМодель для работы со списками однотипных данных.\n\n## Сторы\n\n### RootStore\n\nОт этого стора должен быть отнаследован RootStore вашего приложения. В конструкторе нужно передать в параметрах объект эндпоинтов API (тип `EndpointsType` с обязательным эндпоинтом для авторизации в поле `auth`). Это необходимо для того, чтоб все подсторы могли иметь доступ к одному и тому же объекту доступных эндпоинтов API через поле \\_endpoints в RootStore. Пример использования приведен ниже.\n\n```typescript\nimport {\n  RootStore as BaseRootStore,\n  EndpointsType,\n} from '@ktsstudio/mediaproject-stores';\n\nconst ENDPOINTS: EndpointsType = {\n  auth: {\n    url: 'https//backend/api/auth',\n    method: 'GET', // можно не указывать, если метод GET\n  },\n};\n\nclass RootStore extends BaseRootStore {\n  constructor() {\n    super(ENDPOINTS);\n  }\n}\n\nconst rootStore = new RootStore(ENDPOINTS);\n\nconsole.log(rootStore.endpoints); // { auth: { url: 'https//backend/api/auth', method: 'GET' } }\n```\n\n### UserStore\n\nСтор для работы с данными юзера. Должен находиться внутри RootStore, так как наследуется от SubStoreModel.\nПринимает в конструкторе ссылку на него. UserStore в вашем приложении должен быть отнаследован от этого стора. Пример использования приведен ниже.\n\n```typescript\n// store/RootStore.ts\n\n// \u003c...\u003e\nimport {\n  RootStore as BaseRootStore,\n  UserStore,\n} from '@ktsstudio/mediaproject-stores';\n\nexport default class RootStore extends BaseRootStore {\n  // \u003c...\u003e\n  userStore = new UserStore(this);\n}\n```\n\n```typescript\n// store/hooks.ts\n\nimport { UserStore } from '@ktsstudio/mediaproject-stores';\nimport { MobXProviderContext } from 'mobx-react';\nimport { useContext } from 'react';\n\nexport function useUserStore(): UserStore {\n  return useContext(MobXProviderContext).rootStore.userStore;\n}\n```\n\nОбращение в компоненте:\n\n```typescript\n// MyComponents.ts\n\nimport * as React from 'react';\nimport { observer } from 'mobx';\n\nimport { useUserStore } from 'store/hooks';\n\nconst MyComponent = () =\u003e {\n  const { auth, user, authMeta } = useUserStore();\n\n  React.useEffect(() =\u003e {\n    auth();\n  }, []);\n\n  if (authMeta.isLoading) {\n    return \u003cdiv\u003eLoading...\u003c/div\u003e;\n  }\n\n  return \u003cdiv\u003eHello, {user.first_name}\u003c/div\u003e;\n};\n\nexport default observer(MyComponent);\n```\n\n### AppParamsStore\n\nСтор для хранения параметров приложения, которые вычисляются на запуске.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fktsstudio%2Fmediaproject-stores","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fktsstudio%2Fmediaproject-stores","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fktsstudio%2Fmediaproject-stores/lists"}