samsung-device-helper 0.0.1 → 0.0.2

package/README.md

@@ -1 +1,94 @@
-# TBD
+# Samsung Device Helper
+
+`samsung-device-helper` is an npm package designed to provide a comprehensive list of Samsung devices, including phones, tablets, and watches. It offers utility functions to retrieve device names by model and fetch lists of devices by category.
+
+## Installation
+
+To install the package, run:
+
+```bash
+npm install samsung-device-helper
+```
+
+## Usage
+
+Here's a quick guide on how to use the `samsung-device-helper` package in your project.
+
+### Importing the Package
+
+First, import the necessary functions from the package:
+
+```javascript
+const {
+  getNameByModel,
+  getAllSamsungPhones,
+  getAllSamsungTablets,
+  getAllSamsungWatches,
+  getAllSamsungDevices,
+} = require("samsung-device-helper");
+```
+
+### Functions
+
+#### `getNameByModel(model: string): string`
+
+This function takes a device model as an argument and returns the corresponding device name. If the model is not recognized, it returns the model itself.
+
+```javascript
+const deviceName = getNameByModel("SM-G991B");
+console.log(deviceName); // Outputs: "Galaxy S21 5G"
+```
+
+#### `getAllSamsungPhones(): Device[]`
+
+Returns an array of all Samsung phones.
+
+```javascript
+const phones = getAllSamsungPhones();
+console.log(phones);
+```
+
+#### `getAllSamsungTablets(): Device[]`
+
+Returns an array of all Samsung tablets.
+
+```javascript
+const tablets = getAllSamsungTablets();
+console.log(tablets);
+```
+
+#### `getAllSamsungWatches(): Device[]`
+
+Returns an array of all Samsung watches.
+
+```javascript
+const watches = getAllSamsungWatches();
+console.log(watches);
+```
+
+#### `getAllSamsungDevices(): Device[]`
+
+Returns an array of all Samsung devices, including phones, tablets, and watches.
+
+```javascript
+const devices = getAllSamsungDevices();
+console.log(devices);
+```
+
+## Contributing
+
+If you'd like to contribute to this project, please submit a pull request or open an issue on GitHub.
+
+## License
+
+This project is licensed under the MIT License.
+
+---
+
+For more information, visit the [GitHub repository](https://github.com/yourusername/samsung-device-helper).
+
+## Acknowledgments
+
+This package is inspired by the need to simplify the retrieval and management of Samsung device data for developers.
+
+Happy coding!

package/dist/device-helper.d.ts

@@ -0,0 +1,6 @@
+import { Device } from "./types";
+export declare const getNameByModel: (model: string) => string;
+export declare const getAllSamsungPhones: () => Device[];
+export declare const getAllSamsungTablets: () => Device[];
+export declare const getAllSamsungWatches: () => Device[];
+export declare const getAllSamsungDevices: () => Device[];

package/dist/device-helper.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAllSamsungDevices = exports.getAllSamsungWatches = exports.getAllSamsungTablets = exports.getAllSamsungPhones = exports.getNameByModel = void 0;
+const getNameByModel = (model) => {
+    if (model === "SM-G991B") {
+        return "Galaxy S21 5G";
+    }
+    return model;
+};
+exports.getNameByModel = getNameByModel;
+const getAllSamsungPhones = () => {
+    return [
+        {
+            model: "SM-G991B",
+            name: "Galaxy S21 5G",
+            releaseDate: "2021-01-29",
+            type: "phone",
+        },
+        // complete full list
+    ];
+};
+exports.getAllSamsungPhones = getAllSamsungPhones;
+const getAllSamsungTablets = () => {
+    return [
+        {
+            model: "SM-T970",
+            name: "Galaxy Tab S7",
+            releaseDate: "2020-08-05",
+            type: "tablet",
+        },
+        // complete full list
+    ];
+};
+exports.getAllSamsungTablets = getAllSamsungTablets;
+const getAllSamsungWatches = () => {
+    return [
+        {
+            model: "SM-R800",
+            name: "Galaxy Watch",
+            releaseDate: "2018-08-24",
+            type: "watch",
+        },
+        // complete full list
+    ];
+};
+exports.getAllSamsungWatches = getAllSamsungWatches;
+const getAllSamsungDevices = () => {
+    return [
+        ...(0, exports.getAllSamsungPhones)(),
+        ...(0, exports.getAllSamsungTablets)(),
+        ...(0, exports.getAllSamsungWatches)(),
+    ];
+};
+exports.getAllSamsungDevices = getAllSamsungDevices;

package/dist/index.d.ts

@@ -1 +1,2 @@
-export declare const getNameByModel: (model: string) => string;
+export * from "./types";
+export * from "./device-helper";

package/dist/index.js

@@ -1,10 +1,18 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getNameByModel = void 0;
-const getNameByModel = (model) => {
-    if (model === "SM-G991B") {
-        return "Galaxy S21 5G";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
     }
-    return model;
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
-exports.getNameByModel = getNameByModel;
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types"), exports);
+__exportStar(require("./device-helper"), exports);

package/dist/types.d.ts

@@ -0,0 +1,7 @@
+export type DeviceType = "phone" | "tablet" | "watch";
+export type Device = {
+    model: string;
+    name: string;
+    releaseDate: string;
+    type: DeviceType;
+};

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "samsung-device-helper",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "A utility to help you identify Samsung devices",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -34,7 +34,6 @@
   "bugs": {
     "url": "https://github.com/kulcsarrudolf/samsung-device-helper/issues"
   },
-  "homepage": "https://kulcsarrudolf.com/samsung-device-helper",
   "devDependencies": {
     "@types/chai": "^4.3.5",
     "@types/mocha": "^10.0.1",