├── .gitignore
├── README.md
├── examples.txt
├── index.js
├── package.json
└── yarn.lock


/.gitignore:
--------------------------------------------------------------------------------
 1 | # Logs
 2 | logs
 3 | *.log
 4 | npm-debug.log*
 5 | yarn-debug.log*
 6 | yarn-error.log*
 7 | 
 8 | # Runtime data
 9 | pids
10 | *.pid
11 | *.seed
12 | *.pid.lock
13 | 
14 | # Directory for instrumented libs generated by jscoverage/JSCover
15 | lib-cov
16 | 
17 | # Coverage directory used by tools like istanbul
18 | coverage
19 | 
20 | # nyc test coverage
21 | .nyc_output
22 | 
23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
24 | .grunt
25 | 
26 | # Bower dependency directory (https://bower.io/)
27 | bower_components
28 | 
29 | # node-waf configuration
30 | .lock-wscript
31 | 
32 | # Compiled binary addons (https://nodejs.org/api/addons.html)
33 | build/Release
34 | 
35 | # Dependency directories
36 | node_modules/
37 | jspm_packages/
38 | 
39 | # TypeScript v1 declaration files
40 | typings/
41 | 
42 | # Optional npm cache directory
43 | .npm
44 | 
45 | # Optional eslint cache
46 | .eslintcache
47 | 
48 | # Optional REPL history
49 | .node_repl_history
50 | 
51 | # Output of 'npm pack'
52 | *.tgz
53 | 
54 | # Yarn Integrity file
55 | .yarn-integrity
56 | 
57 | # dotenv environment variables file
58 | .env
59 | 
60 | # parcel-bundler cache (https://parceljs.org/)
61 | .cache
62 | 
63 | # next.js build output
64 | .next
65 | 
66 | # nuxt.js build output
67 | .nuxt
68 | 
69 | # vuepress build output
70 | .vuepress/dist
71 | 
72 | # Serverless directories
73 | .serverless
74 | 
75 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # sequelize-typescript-associations
  2 | 
  3 | Generate ModelInstance interfaces for your sequelize models. The ModelInstance interface should include type definitions (using Sequelize mixins) for all functions for working with associations.
  4 | 
  5 | ## Usage
  6 | 
  7 | ```shell
  8 | $ yarn gen -b User -a Collection Collection Image Image User -s AssignerCollection AssigneeCollection ProfilePhoto ImageCreated InvitedBy -p AssignerCollections AssigneeCollections _ ImagesCreated _ -t HasMany BelongsToMany BelongsTo HasMany BelongsTo -j _ CollectionAssignee _ _ _
  9 | ```
 10 | 
 11 | This will generate the following interface:
 12 | 
 13 | ```typescript
 14 | export interface UserInstance extends Sequelize.Instance<UserAttributes>, UserAttributes {
 15 |     getAssignerCollections: Sequelize.HasManyGetAssociationsMixin<CollectionInstance>;
 16 |     setAssignerCollections: Sequelize.HasManySetAssociationsMixin<CollectionInstance, CollectionInstance["id"]>;
 17 |     addAssignerCollections: Sequelize.HasManyAddAssociationsMixin<CollectionInstance, CollectionInstance["id"]>;
 18 |     addAssignerCollection: Sequelize.HasManyAddAssociationMixin<CollectionInstance, CollectionInstance["id"]>;
 19 |     createAssignerCollection: Sequelize.HasManyCreateAssociationMixin<CollectionAttributes, CollectionInstance>;
 20 |     removeAssignerCollection: Sequelize.HasManyRemoveAssociationMixin<CollectionInstance, CollectionInstance["id"]>;
 21 |     removeAssignerCollections: Sequelize.HasManyRemoveAssociationsMixin<CollectionInstance, CollectionInstance["id"]>;
 22 |     hasAssignerCollection: Sequelize.HasManyHasAssociationMixin<CollectionInstance, CollectionInstance["id"]>;
 23 |     hasAssignerCollections: Sequelize.HasManyHasAssociationsMixin<CollectionInstance, CollectionInstance["id"]>;
 24 |     countAssignerCollections: Sequelize.HasManyCountAssociationsMixin;
 25 | 
 26 |     getAssigneeCollections: Sequelize.BelongsToManyGetAssociationsMixin<CollectionInstance>;
 27 |     setAssigneeCollections: Sequelize.BelongsToManySetAssociationsMixin<CollectionInstance, CollectionInstance["id"], CollectionAssigneeAttributes>;
 28 |     addAssigneeCollections: Sequelize.BelongsToManyAddAssociationsMixin<CollectionInstance, CollectionInstance["id"], CollectionAssigneeAttributes>;
 29 |     addAssigneeCollection: Sequelize.BelongsToManyAddAssociationMixin<CollectionInstance, CollectionInstance["id"], CollectionAssigneeAttributes>;
 30 |     createAssigneeCollection: Sequelize.BelongsToManyCreateAssociationMixin<CollectionAttributes, CollectionInstance["id"], CollectionAssigneeAttributes>;
 31 |     removeAssigneeCollection: Sequelize.BelongsToManyRemoveAssociationMixin<CollectionInstance, CollectionInstance["id"]>;
 32 |     removeAssigneeCollections: Sequelize.BelongsToManyRemoveAssociationsMixin<CollectionInstance, CollectionInstance["id"]>;
 33 |     hasAssigneeCollection: Sequelize.BelongsToManyHasAssociationMixin<CollectionInstance, CollectionInstance["id"]>;
 34 |     hasAssigneeCollections: Sequelize.BelongsToManyHasAssociationsMixin<CollectionInstance, CollectionInstance["id"]>;
 35 |     countAssigneeCollections: Sequelize.BelongsToManyCountAssociationsMixin;
 36 | 
 37 |     getProfilePhoto: Sequelize.BelongsToGetAssociationMixin<ImageInstance>;
 38 |     setProfilePhoto: Sequelize.BelongsToSetAssociationMixin<ImageInstance, ImageInstance["id"]>;
 39 |     createProfilePhoto: Sequelize.BelongsToCreateAssociationMixin<ImageAttributes>;
 40 | 
 41 |     getImagesCreated: Sequelize.HasManyGetAssociationsMixin<ImageInstance>;
 42 |     setImagesCreated: Sequelize.HasManySetAssociationsMixin<ImageInstance, ImageInstance["id"]>;
 43 |     addImagesCreated: Sequelize.HasManyAddAssociationsMixin<ImageInstance, ImageInstance["id"]>;
 44 |     addImageCreated: Sequelize.HasManyAddAssociationMixin<ImageInstance, ImageInstance["id"]>;
 45 |     createImageCreated: Sequelize.HasManyCreateAssociationMixin<ImageAttributes, ImageInstance>;
 46 |     removeImageCreated: Sequelize.HasManyRemoveAssociationMixin<ImageInstance, ImageInstance["id"]>;
 47 |     removeImagesCreated: Sequelize.HasManyRemoveAssociationsMixin<ImageInstance, ImageInstance["id"]>;
 48 |     hasImageCreated: Sequelize.HasManyHasAssociationMixin<ImageInstance, ImageInstance["id"]>;
 49 |     hasImagesCreated: Sequelize.HasManyHasAssociationsMixin<ImageInstance, ImageInstance["id"]>;
 50 |     countImagesCreated: Sequelize.HasManyCountAssociationsMixin;
 51 | 
 52 |     getInvitedBy: Sequelize.BelongsToGetAssociationMixin<UserInstance>;
 53 |     setInvitedBy: Sequelize.BelongsToSetAssociationMixin<UserInstance, UserInstance["id"]>;
 54 |     createInvitedBy: Sequelize.BelongsToCreateAssociationMixin<UserAttributes>;
 55 |   };
 56 | ```
 57 | 
 58 | The usage is as follows.
 59 | 
 60 |  - The argument following the -b flag gives the base model for which we are creating the interface for.
 61 | 
 62 |  - The array of arguments following the -a flag give the model name's for the models for which we are creating associations for.
 63 | 
 64 |  - The array of arguments following the -s flag give the aliases you want to give for each association, in singular form.
 65 | 
 66 |  - The array of arguments following the -p flag give the aliases you want to give for each association, in plural form.
 67 | 
 68 |  - The array of arguments following the -t flag give the type of association, i.e. on of BelongsTo, BelongsToMany, HasOne, or HasMany. These should match the function used in to create the association in the Model.associate function.
 69 | 
 70 |  - The array of arguments following the -j flag give the name of the join table to use for the BelongsToMany (n:m) association.
 71 | 
 72 | Note that,
 73 | 
 74 |  - the i'th argument in each array correspond to each other.
 75 | 
 76 |  - if giving an argument for the i'th association doesn't apply, an underscore should be given. E.g., in above example, a User only has one ProfilePhoto, so it doesn't have a plural. Similarly, for InvitedBy. Also observe, only AssigneeCollections is a many-to-many (as BelongsToMany is used to define it) so we don't need to specify join tables for the other associations.
 77 |  
 78 |  ## Using Custom Join Tables
 79 |  
 80 |  In Sequelize, one may simply specify a join table name on both BelongsToMany calls to have sequelize automatically create a join table in the schema. E.g,
 81 |  
 82 |  ```typescript
 83 | Collection.BelongsToMany(Image, { through: "CollectionImage" });
 84 | Image.BelongsToMany(Collection, { through: "CollectionImage" });
 85 | ```
 86 | 
 87 | If you want to add more attributes to the join table, or customise it in some way, you can define the join table just like any other model and than set that to the `through` field. E.g.,
 88 | 
 89 | ```typescript
 90 | User.BelongsToMany(Collection, { through: CollectionAssigneeAttributes });
 91 | Collection.BelongsToMany(User, { through: CollectionAssigneeAttributes });
 92 | ```
 93 | 
 94 | Which is chosen has implications on the mixin definitions. Consider the mixins for the above to n:m associations. The first is defined as follows. Note the third type parameter to the mixin.
 95 | 
 96 | ```typescript
 97 | setImages: Sequelize.BelongsToManySetAssociationsMixin<ImageInstance, ImageInstance["id"], "CollectionImage">
 98 | ```
 99 | 
100 | In this case, we only want to pass in the string of the join table name. In the other case, the join table is defined manually, so the join tables Attribute's interface needs to be passed in as the last parameter. 
101 | 
102 | ```typescript
103 | setAssigneeCollections: Sequelize.BelongsToManySetAssociationsMixin<CollectionInstance, CollectionInstance["id"], CollectionAssigneeAttributes>;
104 | ```
105 | 
106 | This library supports both. To force the latter case, simply pass in a join table model name, e.g. `-j CollectionAssignee`, and the script will automatically put `CollectionAssigneeAttributes` in the third type parameter. For the former case, wrap the join table name in double quotes (probably have to be escaped at command line). E.g., `-j \"CollectionImage\"` will put `"CollectionImage"` in the third type parameter.
107 | 
108 | ## Known Issues
109 | 
110 | This library assumes that the primary key of the association will always be its `id` field. This is not always the case (e.g. the primary key of an image could be its hash). 
111 | 


--------------------------------------------------------------------------------
/examples.txt:
--------------------------------------------------------------------------------
  1 | yarn run v1.7.0
  2 | $ node index.js -b CollectionImage -a User -s ActionedBy -p _ -t BelongsTo -j _
  3 | export interface CollectionImageInstance extends Sequelize.Instance<CollectionImageAttributes>, CollectionImageAttributes {
  4 |       
  5 |     getActionedBy: Sequelize.BelongsToGetAssociationMixin<UserInstance>;
  6 |     setActionedBy: Sequelize.BelongsToSetAssociationMixin<UserInstance, UserInstance["id"]>;
  7 |     createActionedBy: Sequelize.BelongsToCreateAssociationMixin<UserAttributes>;
  8 |     
  9 |   };
 10 |     
 11 | Done in 0.16s.
 12 | yarn run v1.7.0
 13 | $ node index.js -b Image -a Tag Collection User User Annotation AnnotationHistory ModelDataSet -s Tag Collection DeletedBy CreatedBy Annotation AnnotationHistory ModelDataSet -p Tags Collections _ _ Annotations AnnotationHistories ModelDataSets -t BelongsToMany BelongsToMany BelongsTo BelongsTo HasMany HasMany BelongsToMany -j '"ImageTag"' CollectionImage _ _ _ _ ModelDataSetImage
 14 | export interface ImageInstance extends Sequelize.Instance<ImageAttributes>, ImageAttributes {
 15 |       
 16 |     getTags: Sequelize.BelongsToManyGetAssociationsMixin<TagInstance>;
 17 |     setTags: Sequelize.BelongsToManySetAssociationsMixin<TagInstance, TagInstance["id"], "ImageTag">;
 18 |     addTags: Sequelize.BelongsToManyAddAssociationsMixin<TagInstance, TagInstance["id"], "ImageTag">;
 19 |     addTag: Sequelize.BelongsToManyAddAssociationMixin<TagInstance, TagInstance["id"], "ImageTag">;
 20 |     createTag: Sequelize.BelongsToManyCreateAssociationMixin<TagAttributes, TagInstance["id"], "ImageTag">;
 21 |     removeTag: Sequelize.BelongsToManyRemoveAssociationMixin<TagInstance, TagInstance["id"]>;
 22 |     removeTags: Sequelize.BelongsToManyRemoveAssociationsMixin<TagInstance, TagInstance["id"]>;
 23 |     hasTag: Sequelize.BelongsToManyHasAssociationMixin<TagInstance, TagInstance["id"]>;
 24 |     hasTags: Sequelize.BelongsToManyHasAssociationsMixin<TagInstance, TagInstance["id"]>;
 25 |     countTags: Sequelize.BelongsToManyCountAssociationsMixin;
 26 |     
 27 |     getCollections: Sequelize.BelongsToManyGetAssociationsMixin<CollectionInstance>;
 28 |     setCollections: Sequelize.BelongsToManySetAssociationsMixin<CollectionInstance, CollectionInstance["id"], CollectionImageAttributes>;
 29 |     addCollections: Sequelize.BelongsToManyAddAssociationsMixin<CollectionInstance, CollectionInstance["id"], CollectionImageAttributes>;
 30 |     addCollection: Sequelize.BelongsToManyAddAssociationMixin<CollectionInstance, CollectionInstance["id"], CollectionImageAttributes>;
 31 |     createCollection: Sequelize.BelongsToManyCreateAssociationMixin<CollectionAttributes, CollectionInstance["id"], CollectionImageAttributes>;
 32 |     removeCollection: Sequelize.BelongsToManyRemoveAssociationMixin<CollectionInstance, CollectionInstance["id"]>;
 33 |     removeCollections: Sequelize.BelongsToManyRemoveAssociationsMixin<CollectionInstance, CollectionInstance["id"]>;
 34 |     hasCollection: Sequelize.BelongsToManyHasAssociationMixin<CollectionInstance, CollectionInstance["id"]>;
 35 |     hasCollections: Sequelize.BelongsToManyHasAssociationsMixin<CollectionInstance, CollectionInstance["id"]>;
 36 |     countCollections: Sequelize.BelongsToManyCountAssociationsMixin;
 37 |     
 38 |     getDeletedBy: Sequelize.BelongsToGetAssociationMixin<UserInstance>;
 39 |     setDeletedBy: Sequelize.BelongsToSetAssociationMixin<UserInstance, UserInstance["id"]>;
 40 |     createDeletedBy: Sequelize.BelongsToCreateAssociationMixin<UserAttributes>;
 41 |     
 42 |     getCreatedBy: Sequelize.BelongsToGetAssociationMixin<UserInstance>;
 43 |     setCreatedBy: Sequelize.BelongsToSetAssociationMixin<UserInstance, UserInstance["id"]>;
 44 |     createCreatedBy: Sequelize.BelongsToCreateAssociationMixin<UserAttributes>;
 45 |     
 46 |     getAnnotations: Sequelize.HasManyGetAssociationsMixin<AnnotationInstance>;
 47 |     setAnnotations: Sequelize.HasManySetAssociationsMixin<AnnotationInstance, AnnotationInstance["id"]>;
 48 |     addAnnotations: Sequelize.HasManyAddAssociationsMixin<AnnotationInstance, AnnotationInstance["id"]>;
 49 |     addAnnotation: Sequelize.HasManyAddAssociationMixin<AnnotationInstance, AnnotationInstance["id"]>;
 50 |     createAnnotation: Sequelize.HasManyCreateAssociationMixin<AnnotationAttributes, AnnotationInstance>;
 51 |     removeAnnotation: Sequelize.HasManyRemoveAssociationMixin<AnnotationInstance, AnnotationInstance["id"]>;
 52 |     removeAnnotations: Sequelize.HasManyRemoveAssociationsMixin<AnnotationInstance, AnnotationInstance["id"]>;
 53 |     hasAnnotation: Sequelize.HasManyHasAssociationMixin<AnnotationInstance, AnnotationInstance["id"]>;
 54 |     hasAnnotations: Sequelize.HasManyHasAssociationsMixin<AnnotationInstance, AnnotationInstance["id"]>;
 55 |     countAnnotations: Sequelize.HasManyCountAssociationsMixin;
 56 |     
 57 |     getAnnotationHistories: Sequelize.HasManyGetAssociationsMixin<AnnotationHistoryInstance>;
 58 |     setAnnotationHistories: Sequelize.HasManySetAssociationsMixin<AnnotationHistoryInstance, AnnotationHistoryInstance["id"]>;
 59 |     addAnnotationHistories: Sequelize.HasManyAddAssociationsMixin<AnnotationHistoryInstance, AnnotationHistoryInstance["id"]>;
 60 |     addAnnotationHistory: Sequelize.HasManyAddAssociationMixin<AnnotationHistoryInstance, AnnotationHistoryInstance["id"]>;
 61 |     createAnnotationHistory: Sequelize.HasManyCreateAssociationMixin<AnnotationHistoryAttributes, AnnotationHistoryInstance>;
 62 |     removeAnnotationHistory: Sequelize.HasManyRemoveAssociationMixin<AnnotationHistoryInstance, AnnotationHistoryInstance["id"]>;
 63 |     removeAnnotationHistories: Sequelize.HasManyRemoveAssociationsMixin<AnnotationHistoryInstance, AnnotationHistoryInstance["id"]>;
 64 |     hasAnnotationHistory: Sequelize.HasManyHasAssociationMixin<AnnotationHistoryInstance, AnnotationHistoryInstance["id"]>;
 65 |     hasAnnotationHistories: Sequelize.HasManyHasAssociationsMixin<AnnotationHistoryInstance, AnnotationHistoryInstance["id"]>;
 66 |     countAnnotationHistories: Sequelize.HasManyCountAssociationsMixin;
 67 |     
 68 |     getModelDataSets: Sequelize.BelongsToManyGetAssociationsMixin<ModelDataSetInstance>;
 69 |     setModelDataSets: Sequelize.BelongsToManySetAssociationsMixin<ModelDataSetInstance, ModelDataSetInstance["id"], ModelDataSetImageAttributes>;
 70 |     addModelDataSets: Sequelize.BelongsToManyAddAssociationsMixin<ModelDataSetInstance, ModelDataSetInstance["id"], ModelDataSetImageAttributes>;
 71 |     addModelDataSet: Sequelize.BelongsToManyAddAssociationMixin<ModelDataSetInstance, ModelDataSetInstance["id"], ModelDataSetImageAttributes>;
 72 |     createModelDataSet: Sequelize.BelongsToManyCreateAssociationMixin<ModelDataSetAttributes, ModelDataSetInstance["id"], ModelDataSetImageAttributes>;
 73 |     removeModelDataSet: Sequelize.BelongsToManyRemoveAssociationMixin<ModelDataSetInstance, ModelDataSetInstance["id"]>;
 74 |     removeModelDataSets: Sequelize.BelongsToManyRemoveAssociationsMixin<ModelDataSetInstance, ModelDataSetInstance["id"]>;
 75 |     hasModelDataSet: Sequelize.BelongsToManyHasAssociationMixin<ModelDataSetInstance, ModelDataSetInstance["id"]>;
 76 |     hasModelDataSets: Sequelize.BelongsToManyHasAssociationsMixin<ModelDataSetInstance, ModelDataSetInstance["id"]>;
 77 |     countModelDataSets: Sequelize.BelongsToManyCountAssociationsMixin;
 78 |     
 79 |   };
 80 |     
 81 | Done in 0.15s.
 82 | yarn run v1.7.0
 83 | $ node index.js -b Model -a ClassGroup ModelDataSet -s ClassGroup DataSet -p ClassGroups DataSets -t BelongsTo HasMany -j _ _
 84 | export interface ModelInstance extends Sequelize.Instance<ModelAttributes>, ModelAttributes {
 85 |       
 86 |     getClassGroup: Sequelize.BelongsToGetAssociationMixin<ClassGroupInstance>;
 87 |     setClassGroup: Sequelize.BelongsToSetAssociationMixin<ClassGroupInstance, ClassGroupInstance["id"]>;
 88 |     createClassGroup: Sequelize.BelongsToCreateAssociationMixin<ClassGroupAttributes>;
 89 |     
 90 |     getDataSets: Sequelize.HasManyGetAssociationsMixin<ModelDataSetInstance>;
 91 |     setDataSets: Sequelize.HasManySetAssociationsMixin<ModelDataSetInstance, ModelDataSetInstance["id"]>;
 92 |     addDataSets: Sequelize.HasManyAddAssociationsMixin<ModelDataSetInstance, ModelDataSetInstance["id"]>;
 93 |     addDataSet: Sequelize.HasManyAddAssociationMixin<ModelDataSetInstance, ModelDataSetInstance["id"]>;
 94 |     createDataSet: Sequelize.HasManyCreateAssociationMixin<ModelDataSetAttributes, ModelDataSetInstance>;
 95 |     removeDataSet: Sequelize.HasManyRemoveAssociationMixin<ModelDataSetInstance, ModelDataSetInstance["id"]>;
 96 |     removeDataSets: Sequelize.HasManyRemoveAssociationsMixin<ModelDataSetInstance, ModelDataSetInstance["id"]>;
 97 |     hasDataSet: Sequelize.HasManyHasAssociationMixin<ModelDataSetInstance, ModelDataSetInstance["id"]>;
 98 |     hasDataSets: Sequelize.HasManyHasAssociationsMixin<ModelDataSetInstance, ModelDataSetInstance["id"]>;
 99 |     countDataSets: Sequelize.HasManyCountAssociationsMixin;
100 |     
101 |   };
102 |     
103 | Done in 0.17s.
104 | yarn run v1.7.0
105 | $ node index.js -b ModelDataSet -a Model Image -s Model Image -p _ Images -t BelongsTo BelongsToMany -j _ ModelDataSetImage
106 | export interface ModelDataSetInstance extends Sequelize.Instance<ModelDataSetAttributes>, ModelDataSetAttributes {
107 |       
108 |     getModel: Sequelize.BelongsToGetAssociationMixin<ModelInstance>;
109 |     setModel: Sequelize.BelongsToSetAssociationMixin<ModelInstance, ModelInstance["id"]>;
110 |     createModel: Sequelize.BelongsToCreateAssociationMixin<ModelAttributes>;
111 |     
112 |     getImages: Sequelize.BelongsToManyGetAssociationsMixin<ImageInstance>;
113 |     setImages: Sequelize.BelongsToManySetAssociationsMixin<ImageInstance, ImageInstance["id"], ModelDataSetImageAttributes>;
114 |     addImages: Sequelize.BelongsToManyAddAssociationsMixin<ImageInstance, ImageInstance["id"], ModelDataSetImageAttributes>;
115 |     addImage: Sequelize.BelongsToManyAddAssociationMixin<ImageInstance, ImageInstance["id"], ModelDataSetImageAttributes>;
116 |     createImage: Sequelize.BelongsToManyCreateAssociationMixin<ImageAttributes, ImageInstance["id"], ModelDataSetImageAttributes>;
117 |     removeImage: Sequelize.BelongsToManyRemoveAssociationMixin<ImageInstance, ImageInstance["id"]>;
118 |     removeImages: Sequelize.BelongsToManyRemoveAssociationsMixin<ImageInstance, ImageInstance["id"]>;
119 |     hasImage: Sequelize.BelongsToManyHasAssociationMixin<ImageInstance, ImageInstance["id"]>;
120 |     hasImages: Sequelize.BelongsToManyHasAssociationsMixin<ImageInstance, ImageInstance["id"]>;
121 |     countImages: Sequelize.BelongsToManyCountAssociationsMixin;
122 |     
123 |   };
124 |     
125 | Done in 0.17s.
126 | yarn run v1.7.0
127 | $ node index.js -b User -a Collection Collection CollectionImage Image Image -s AssignerCollection AssigneeCollection CollectionImageActionedOn ImageCreated ImageDeleted -p AssignerCollections AssigneeCollections CollectionImagesActionedOn ImagesCreated ImagesDeleted -t HasMany BelongsToMany HasMany HasMany HasMany -j _ '"CollectionAssignee"' _ _ _
128 | export interface UserInstance extends Sequelize.Instance<UserAttributes>, UserAttributes {
129 |       
130 |     getAssignerCollections: Sequelize.HasManyGetAssociationsMixin<CollectionInstance>;
131 |     setAssignerCollections: Sequelize.HasManySetAssociationsMixin<CollectionInstance, CollectionInstance["id"]>;
132 |     addAssignerCollections: Sequelize.HasManyAddAssociationsMixin<CollectionInstance, CollectionInstance["id"]>;
133 |     addAssignerCollection: Sequelize.HasManyAddAssociationMixin<CollectionInstance, CollectionInstance["id"]>;
134 |     createAssignerCollection: Sequelize.HasManyCreateAssociationMixin<CollectionAttributes, CollectionInstance>;
135 |     removeAssignerCollection: Sequelize.HasManyRemoveAssociationMixin<CollectionInstance, CollectionInstance["id"]>;
136 |     removeAssignerCollections: Sequelize.HasManyRemoveAssociationsMixin<CollectionInstance, CollectionInstance["id"]>;
137 |     hasAssignerCollection: Sequelize.HasManyHasAssociationMixin<CollectionInstance, CollectionInstance["id"]>;
138 |     hasAssignerCollections: Sequelize.HasManyHasAssociationsMixin<CollectionInstance, CollectionInstance["id"]>;
139 |     countAssignerCollections: Sequelize.HasManyCountAssociationsMixin;
140 |     
141 |     getAssigneeCollections: Sequelize.BelongsToManyGetAssociationsMixin<CollectionInstance>;
142 |     setAssigneeCollections: Sequelize.BelongsToManySetAssociationsMixin<CollectionInstance, CollectionInstance["id"], "CollectionAssignee">;
143 |     addAssigneeCollections: Sequelize.BelongsToManyAddAssociationsMixin<CollectionInstance, CollectionInstance["id"], "CollectionAssignee">;
144 |     addAssigneeCollection: Sequelize.BelongsToManyAddAssociationMixin<CollectionInstance, CollectionInstance["id"], "CollectionAssignee">;
145 |     createAssigneeCollection: Sequelize.BelongsToManyCreateAssociationMixin<CollectionAttributes, CollectionInstance["id"], "CollectionAssignee">;
146 |     removeAssigneeCollection: Sequelize.BelongsToManyRemoveAssociationMixin<CollectionInstance, CollectionInstance["id"]>;
147 |     removeAssigneeCollections: Sequelize.BelongsToManyRemoveAssociationsMixin<CollectionInstance, CollectionInstance["id"]>;
148 |     hasAssigneeCollection: Sequelize.BelongsToManyHasAssociationMixin<CollectionInstance, CollectionInstance["id"]>;
149 |     hasAssigneeCollections: Sequelize.BelongsToManyHasAssociationsMixin<CollectionInstance, CollectionInstance["id"]>;
150 |     countAssigneeCollections: Sequelize.BelongsToManyCountAssociationsMixin;
151 |     
152 |     getCollectionImagesActionedOn: Sequelize.HasManyGetAssociationsMixin<CollectionImageInstance>;
153 |     setCollectionImagesActionedOn: Sequelize.HasManySetAssociationsMixin<CollectionImageInstance, CollectionImageInstance["id"]>;
154 |     addCollectionImagesActionedOn: Sequelize.HasManyAddAssociationsMixin<CollectionImageInstance, CollectionImageInstance["id"]>;
155 |     addCollectionImageActionedOn: Sequelize.HasManyAddAssociationMixin<CollectionImageInstance, CollectionImageInstance["id"]>;
156 |     createCollectionImageActionedOn: Sequelize.HasManyCreateAssociationMixin<CollectionImageAttributes, CollectionImageInstance>;
157 |     removeCollectionImageActionedOn: Sequelize.HasManyRemoveAssociationMixin<CollectionImageInstance, CollectionImageInstance["id"]>;
158 |     removeCollectionImagesActionedOn: Sequelize.HasManyRemoveAssociationsMixin<CollectionImageInstance, CollectionImageInstance["id"]>;
159 |     hasCollectionImageActionedOn: Sequelize.HasManyHasAssociationMixin<CollectionImageInstance, CollectionImageInstance["id"]>;
160 |     hasCollectionImagesActionedOn: Sequelize.HasManyHasAssociationsMixin<CollectionImageInstance, CollectionImageInstance["id"]>;
161 |     countCollectionImagesActionedOn: Sequelize.HasManyCountAssociationsMixin;
162 |     
163 |     getImagesCreated: Sequelize.HasManyGetAssociationsMixin<ImageInstance>;
164 |     setImagesCreated: Sequelize.HasManySetAssociationsMixin<ImageInstance, ImageInstance["id"]>;
165 |     addImagesCreated: Sequelize.HasManyAddAssociationsMixin<ImageInstance, ImageInstance["id"]>;
166 |     addImageCreated: Sequelize.HasManyAddAssociationMixin<ImageInstance, ImageInstance["id"]>;
167 |     createImageCreated: Sequelize.HasManyCreateAssociationMixin<ImageAttributes, ImageInstance>;
168 |     removeImageCreated: Sequelize.HasManyRemoveAssociationMixin<ImageInstance, ImageInstance["id"]>;
169 |     removeImagesCreated: Sequelize.HasManyRemoveAssociationsMixin<ImageInstance, ImageInstance["id"]>;
170 |     hasImageCreated: Sequelize.HasManyHasAssociationMixin<ImageInstance, ImageInstance["id"]>;
171 |     hasImagesCreated: Sequelize.HasManyHasAssociationsMixin<ImageInstance, ImageInstance["id"]>;
172 |     countImagesCreated: Sequelize.HasManyCountAssociationsMixin;
173 |     
174 |     getImagesDeleted: Sequelize.HasManyGetAssociationsMixin<ImageInstance>;
175 |     setImagesDeleted: Sequelize.HasManySetAssociationsMixin<ImageInstance, ImageInstance["id"]>;
176 |     addImagesDeleted: Sequelize.HasManyAddAssociationsMixin<ImageInstance, ImageInstance["id"]>;
177 |     addImageDeleted: Sequelize.HasManyAddAssociationMixin<ImageInstance, ImageInstance["id"]>;
178 |     createImageDeleted: Sequelize.HasManyCreateAssociationMixin<ImageAttributes, ImageInstance>;
179 |     removeImageDeleted: Sequelize.HasManyRemoveAssociationMixin<ImageInstance, ImageInstance["id"]>;
180 |     removeImagesDeleted: Sequelize.HasManyRemoveAssociationsMixin<ImageInstance, ImageInstance["id"]>;
181 |     hasImageDeleted: Sequelize.HasManyHasAssociationMixin<ImageInstance, ImageInstance["id"]>;
182 |     hasImagesDeleted: Sequelize.HasManyHasAssociationsMixin<ImageInstance, ImageInstance["id"]>;
183 |     countImagesDeleted: Sequelize.HasManyCountAssociationsMixin;
184 |     
185 |   };
186 |     
187 | Done in 0.15s.
188 | 


--------------------------------------------------------------------------------
/index.js:
--------------------------------------------------------------------------------
  1 | 'use strict';
  2 | 
  3 | const ArgumentParser = require('argparse').ArgumentParser;
  4 | 
  5 | const initArgParser = (ArgParserClass) => {
  6 |   const parser = new ArgParserClass({
  7 |     version: '0.0.1',
  8 |     addHelp: true,
  9 |     description: 'generate mixins given association name'
 10 |   });
 11 |   
 12 |   parser.addArgument(
 13 |     [ '-b', '--baseModelName' ],
 14 |     { help: 'name of base model' },
 15 |   )
 16 |   
 17 |   parser.addArgument(
 18 |     [ '-a', '--associationModelName' ],
 19 |     { help: 'array of name of model of associations', nargs: '+' },
 20 |   );
 21 | 
 22 |   parser.addArgument(
 23 |     [ '-s', '--singular' ],
 24 |     { help: 'array of singular of alias names (the alias for association, may be same as associationModelName)', nargs: '+' }
 25 |   );
 26 |   
 27 |   parser.addArgument(
 28 |     [ '-p', '--plural' ],
 29 |     { help: 'array of plural of alias names (if n/a then use _)', nargs: '+' },
 30 |   );
 31 |   
 32 |   parser.addArgument(
 33 |     [ '-t', '--type' ],
 34 |     { help: 'array of either BelongsTo or HasMany or HasOne or BelongsToMany', nargs: '+' }
 35 |   );
 36 | 
 37 |   parser.addArgument(
 38 |     [ '-j', '--joinTable' ],
 39 |     { help: 'array of join table names, either JoinTableName or an join table attributes e.g. JoinTableAttributes', nargs: '+' }
 40 |   )
 41 | 
 42 |   return parser;
 43 | }
 44 | 
 45 | // FIXME: this doesn't seem to work
 46 | // const assertArgLengthsAreTheSame = (args) => {
 47 | //   ["associationModelName", "plural", "type", "joinTable"].map(k => console.log(args[k].length));
 48 | //   console.log(args.associationModelName.length === args.plural.length === args.type.length === args.joinTable.length);
 49 | //   return args.associationModelName.length === args.plural.length === args.type.length === args.joinTable.length;
 50 | // };
 51 | 
 52 | const addMixinsBelongsTo = (associationModelName, singular) => {
 53 |   const AssocInstance = `${associationModelName}Instance`;
 54 |   const AssocAttributes = `${associationModelName}Attributes`;
 55 |   return (
 56 |     `
 57 |     get${singular}: Sequelize.BelongsToGetAssociationMixin<${AssocInstance}>;
 58 |     set${singular}: Sequelize.BelongsToSetAssociationMixin<${AssocInstance}, ${AssocInstance}["id"]>;
 59 |     create${singular}: Sequelize.BelongsToCreateAssociationMixin<${AssocAttributes}>;
 60 |     `
 61 |   );
 62 | };
 63 | 
 64 | const addMixinsHasOne = (associationModelName, singular) => {
 65 |   const AssocInstance = `${associationModelName}Instance`;
 66 |   const AssocAttributes = `${associationModelName}Attributes`;
 67 |   return (
 68 |     `
 69 |     get${singular}: Sequelize.HasOneGetAssociationMixin<${AssocInstance}>;
 70 |     set${singular}: Sequelize.HasOneSetAssociationMixin<${AssocInstance}, ${AssocInstance}["id"]>;
 71 |     create${singular}: Sequelize.HasOneCreateAssociationMixin<${AssocAttributes}>;
 72 |     `
 73 |   );
 74 | };
 75 | 
 76 | const addMixinsHasMany = (associationModelName, singular, plural) => {
 77 |   const AssocInstance = `${associationModelName}Instance`;
 78 |   const AssocAttributes = `${associationModelName}Attributes`;
 79 |   return (
 80 |     `
 81 |     get${plural}: Sequelize.HasManyGetAssociationsMixin<${AssocInstance}>;
 82 |     set${plural}: Sequelize.HasManySetAssociationsMixin<${AssocInstance}, ${AssocInstance}["id"]>;
 83 |     add${plural}: Sequelize.HasManyAddAssociationsMixin<${AssocInstance}, ${AssocInstance}["id"]>;
 84 |     add${singular}: Sequelize.HasManyAddAssociationMixin<${AssocInstance}, ${AssocInstance}["id"]>;
 85 |     create${singular}: Sequelize.HasManyCreateAssociationMixin<${AssocAttributes}, ${AssocInstance}>;
 86 |     remove${singular}: Sequelize.HasManyRemoveAssociationMixin<${AssocInstance}, ${AssocInstance}["id"]>;
 87 |     remove${plural}: Sequelize.HasManyRemoveAssociationsMixin<${AssocInstance}, ${AssocInstance}["id"]>;
 88 |     has${singular}: Sequelize.HasManyHasAssociationMixin<${AssocInstance}, ${AssocInstance}["id"]>;
 89 |     has${plural}: Sequelize.HasManyHasAssociationsMixin<${AssocInstance}, ${AssocInstance}["id"]>;
 90 |     count${plural}: Sequelize.HasManyCountAssociationsMixin;
 91 |     `
 92 |   );
 93 | };
 94 | 
 95 | const addMixinsBelongsToMany = (associationModelName, singular, plural, joinTableName) => {
 96 |   const AssocInstance = `${associationModelName}Instance`;
 97 |   const AssocAttributes = `${associationModelName}Attributes`;
 98 |   const JoinTableAttributes = joinTableName[0] === '\"' || joinTableName[0] === "\'"
 99 |     ? joinTableName
100 |     : `${joinTableName}Attributes`;
101 | 
102 |   return (
103 |     `
104 |     get${plural}: Sequelize.BelongsToManyGetAssociationsMixin<${AssocInstance}>;
105 |     set${plural}: Sequelize.BelongsToManySetAssociationsMixin<${AssocInstance}, ${AssocInstance}["id"], ${JoinTableAttributes}>;
106 |     add${plural}: Sequelize.BelongsToManyAddAssociationsMixin<${AssocInstance}, ${AssocInstance}["id"], ${JoinTableAttributes}>;
107 |     add${singular}: Sequelize.BelongsToManyAddAssociationMixin<${AssocInstance}, ${AssocInstance}["id"], ${JoinTableAttributes}>;
108 |     create${singular}: Sequelize.BelongsToManyCreateAssociationMixin<${AssocAttributes}, ${AssocInstance}["id"], ${JoinTableAttributes}>;
109 |     remove${singular}: Sequelize.BelongsToManyRemoveAssociationMixin<${AssocInstance}, ${AssocInstance}["id"]>;
110 |     remove${plural}: Sequelize.BelongsToManyRemoveAssociationsMixin<${AssocInstance}, ${AssocInstance}["id"]>;
111 |     has${singular}: Sequelize.BelongsToManyHasAssociationMixin<${AssocInstance}, ${AssocInstance}["id"]>;
112 |     has${plural}: Sequelize.BelongsToManyHasAssociationsMixin<${AssocInstance}, ${AssocInstance}["id"]>;
113 |     count${plural}: Sequelize.BelongsToManyCountAssociationsMixin;
114 |     `
115 |   );
116 | };
117 | 
118 | const generateInterface = ({ baseModelName, associationModelName, singular, plural, type, joinTable }) => {
119 |   let mixinsString = '';
120 |   for (let i = 0; i < associationModelName.length; i++) {
121 |     if (type[i] === "BelongsTo") {
122 |       mixinsString += addMixinsBelongsTo(associationModelName[i], singular[i]);
123 |     } else if (type[i] === "HasOne") {
124 |       mixinsString += addMixinsHasOne(associationModelName[i], singular[i]);
125 |     } else if (type[i] === "HasMany") {
126 |       mixinsString += addMixinsHasMany(associationModelName[i], singular[i], plural[i]);
127 |     } else if (type[i] === "BelongsToMany") {
128 |       mixinsString += addMixinsBelongsToMany(associationModelName[i], singular[i], plural[i], joinTable[i]);
129 |     } else {
130 |       console.error("incorrect type: ", type[i]);
131 |       return;
132 |     }
133 |   }
134 | 
135 |   let interfaceString =
136 |     `export interface ${baseModelName}Instance extends Sequelize.Instance<${baseModelName}Attributes>, ${baseModelName}Attributes {
137 |       ${mixinsString}
138 |   };
139 |     `;
140 | 
141 |   return interfaceString;
142 | };
143 | 
144 | const main = () => {
145 |   const parser = initArgParser(ArgumentParser);
146 |   const args = parser.parseArgs();
147 |   const interfaceString = generateInterface(args);
148 |   console.log(interfaceString);
149 | }
150 | 
151 | main();
152 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "sequelize-typescript-associations",
 3 |   "version": "0.0.1",
 4 |   "description": "generate mixins for ts sqlize ModelInstance interface",
 5 |   "main": "index.js",
 6 |   "author": "Ahmer Butt <ahmer.butt@vivacitylabs.com>",
 7 |   "license": "MIT",
 8 |   "private": true,
 9 |   "scripts": {
10 |     "gen": "node index.js"
11 |   },
12 |   "dependencies": {
13 |     "argparse": "^1.0.10"
14 |   }
15 | }
16 | 


--------------------------------------------------------------------------------
/yarn.lock:
--------------------------------------------------------------------------------
 1 | # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
 2 | # yarn lockfile v1
 3 | 
 4 | 
 5 | argparse@^1.0.10:
 6 |   version "1.0.10"
 7 |   resolved "https://registry.yarnpkg.com/argparse/-/argparse-1.0.10.tgz#bcd6791ea5ae09725e17e5ad988134cd40b3d911"
 8 |   dependencies:
 9 |     sprintf-js "~1.0.2"
10 | 
11 | sprintf-js@~1.0.2:
12 |   version "1.0.3"
13 |   resolved "https://registry.yarnpkg.com/sprintf-js/-/sprintf-js-1.0.3.tgz#04e6926f662895354f3dd015203633b857297e2c"
14 | 


--------------------------------------------------------------------------------