김우재

제출

Showing 1000 changed files with 4817 additions and 0 deletions

Too many changes to show.

To preserve performance only 1000 of 1000+ files are displayed.

File mode changed
This diff is collapsed. Click to expand it.
1 +<?xml version="1.0" encoding="UTF-8"?>
2 +<Workspace
3 + version = "1.0">
4 + <FileRef
5 + location = "self:">
6 + </FileRef>
7 +</Workspace>
1 +<?xml version="1.0" encoding="UTF-8"?>
2 +<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
3 +<plist version="1.0">
4 +<dict>
5 + <key>IDEDidComputeMac32BitWarning</key>
6 + <true/>
7 +</dict>
8 +</plist>
1 +{
2 + "object": {
3 + "pins": [
4 + {
5 + "package": "Kingfisher",
6 + "repositoryURL": "https://github.com/onevcat/Kingfisher",
7 + "state": {
8 + "branch": "master",
9 + "revision": "0c02c46cfdc0656ce74fd0963a75e5000a0b7f23",
10 + "version": null
11 + }
12 + }
13 + ]
14 + },
15 + "version": 1
16 +}
1 +<?xml version="1.0" encoding="UTF-8"?>
2 +<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
3 +<plist version="1.0">
4 +<dict>
5 + <key>SchemeUserState</key>
6 + <dict>
7 + <key>client.xcscheme_^#shared#^_</key>
8 + <dict>
9 + <key>orderHint</key>
10 + <integer>0</integer>
11 + </dict>
12 + </dict>
13 +</dict>
14 +</plist>
1 +//
2 +// AppDelegate.swift
3 +// client
4 +//
5 +// Created by 김우재 on 2021/12/10.
6 +//
7 +
8 +import UIKit
9 +
10 +@main
11 +class AppDelegate: UIResponder, UIApplicationDelegate {
12 +
13 +
14 +
15 + func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
16 + // Override point for customization after application launch.
17 + return true
18 + }
19 +
20 + // MARK: UISceneSession Lifecycle
21 +
22 + func application(_ application: UIApplication, configurationForConnecting connectingSceneSession: UISceneSession, options: UIScene.ConnectionOptions) -> UISceneConfiguration {
23 + // Called when a new scene session is being created.
24 + // Use this method to select a configuration to create the new scene with.
25 + return UISceneConfiguration(name: "Default Configuration", sessionRole: connectingSceneSession.role)
26 + }
27 +
28 + func application(_ application: UIApplication, didDiscardSceneSessions sceneSessions: Set<UISceneSession>) {
29 + // Called when the user discards a scene session.
30 + // If any sessions were discarded while the application was not running, this will be called shortly after application:didFinishLaunchingWithOptions.
31 + // Use this method to release any resources that were specific to the discarded scenes, as they will not return.
32 + }
33 +
34 +
35 +}
36 +
1 +{
2 + "colors" : [
3 + {
4 + "idiom" : "universal"
5 + }
6 + ],
7 + "info" : {
8 + "author" : "xcode",
9 + "version" : 1
10 + }
11 +}
1 +{
2 + "images" : [
3 + {
4 + "idiom" : "iphone",
5 + "scale" : "2x",
6 + "size" : "20x20"
7 + },
8 + {
9 + "idiom" : "iphone",
10 + "scale" : "3x",
11 + "size" : "20x20"
12 + },
13 + {
14 + "idiom" : "iphone",
15 + "scale" : "2x",
16 + "size" : "29x29"
17 + },
18 + {
19 + "idiom" : "iphone",
20 + "scale" : "3x",
21 + "size" : "29x29"
22 + },
23 + {
24 + "idiom" : "iphone",
25 + "scale" : "2x",
26 + "size" : "40x40"
27 + },
28 + {
29 + "idiom" : "iphone",
30 + "scale" : "3x",
31 + "size" : "40x40"
32 + },
33 + {
34 + "idiom" : "iphone",
35 + "scale" : "2x",
36 + "size" : "60x60"
37 + },
38 + {
39 + "idiom" : "iphone",
40 + "scale" : "3x",
41 + "size" : "60x60"
42 + },
43 + {
44 + "idiom" : "ipad",
45 + "scale" : "1x",
46 + "size" : "20x20"
47 + },
48 + {
49 + "idiom" : "ipad",
50 + "scale" : "2x",
51 + "size" : "20x20"
52 + },
53 + {
54 + "idiom" : "ipad",
55 + "scale" : "1x",
56 + "size" : "29x29"
57 + },
58 + {
59 + "idiom" : "ipad",
60 + "scale" : "2x",
61 + "size" : "29x29"
62 + },
63 + {
64 + "idiom" : "ipad",
65 + "scale" : "1x",
66 + "size" : "40x40"
67 + },
68 + {
69 + "idiom" : "ipad",
70 + "scale" : "2x",
71 + "size" : "40x40"
72 + },
73 + {
74 + "idiom" : "ipad",
75 + "scale" : "1x",
76 + "size" : "76x76"
77 + },
78 + {
79 + "idiom" : "ipad",
80 + "scale" : "2x",
81 + "size" : "76x76"
82 + },
83 + {
84 + "idiom" : "ipad",
85 + "scale" : "2x",
86 + "size" : "83.5x83.5"
87 + },
88 + {
89 + "idiom" : "ios-marketing",
90 + "scale" : "1x",
91 + "size" : "1024x1024"
92 + }
93 + ],
94 + "info" : {
95 + "author" : "xcode",
96 + "version" : 1
97 + }
98 +}
1 +{
2 + "info" : {
3 + "author" : "xcode",
4 + "version" : 1
5 + }
6 +}
1 +<?xml version="1.0" encoding="UTF-8" standalone="no"?>
2 +<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="13122.16" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" launchScreen="YES" useTraitCollections="YES" useSafeAreas="YES" colorMatched="YES" initialViewController="01J-lp-oVM">
3 + <dependencies>
4 + <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="13104.12"/>
5 + <capability name="Safe area layout guides" minToolsVersion="9.0"/>
6 + <capability name="documents saved in the Xcode 8 format" minToolsVersion="8.0"/>
7 + </dependencies>
8 + <scenes>
9 + <!--View Controller-->
10 + <scene sceneID="EHf-IW-A2E">
11 + <objects>
12 + <viewController id="01J-lp-oVM" sceneMemberID="viewController">
13 + <view key="view" contentMode="scaleToFill" id="Ze5-6b-2t3">
14 + <rect key="frame" x="0.0" y="0.0" width="375" height="667"/>
15 + <autoresizingMask key="autoresizingMask" widthSizable="YES" heightSizable="YES"/>
16 + <color key="backgroundColor" xcode11CocoaTouchSystemColor="systemBackgroundColor" cocoaTouchSystemColor="whiteColor"/>
17 + <viewLayoutGuide key="safeArea" id="6Tk-OE-BBY"/>
18 + </view>
19 + </viewController>
20 + <placeholder placeholderIdentifier="IBFirstResponder" id="iYj-Kq-Ea1" userLabel="First Responder" sceneMemberID="firstResponder"/>
21 + </objects>
22 + <point key="canvasLocation" x="53" y="375"/>
23 + </scene>
24 + </scenes>
25 +</document>
This diff is collapsed. Click to expand it.
1 +<?xml version="1.0" encoding="UTF-8"?>
2 +<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
3 +<plist version="1.0">
4 +<dict>
5 + <key>UIApplicationSceneManifest</key>
6 + <dict>
7 + <key>UIApplicationSupportsMultipleScenes</key>
8 + <false/>
9 + <key>UISceneConfigurations</key>
10 + <dict>
11 + <key>UIWindowSceneSessionRoleApplication</key>
12 + <array>
13 + <dict>
14 + <key>UISceneConfigurationName</key>
15 + <string>Default Configuration</string>
16 + <key>UISceneDelegateClassName</key>
17 + <string>$(PRODUCT_MODULE_NAME).SceneDelegate</string>
18 + <key>UISceneStoryboardFile</key>
19 + <string>Main</string>
20 + </dict>
21 + </array>
22 + </dict>
23 + </dict>
24 +</dict>
25 +</plist>
1 +//
2 +// SceneDelegate.swift
3 +// client
4 +//
5 +// Created by 김우재 on 2021/12/10.
6 +//
7 +
8 +import UIKit
9 +
10 +class SceneDelegate: UIResponder, UIWindowSceneDelegate {
11 +
12 + var window: UIWindow?
13 +
14 +
15 + func scene(_ scene: UIScene, willConnectTo session: UISceneSession, options connectionOptions: UIScene.ConnectionOptions) {
16 + // Use this method to optionally configure and attach the UIWindow `window` to the provided UIWindowScene `scene`.
17 + // If using a storyboard, the `window` property will automatically be initialized and attached to the scene.
18 + // This delegate does not imply the connecting scene or session are new (see `application:configurationForConnectingSceneSession` instead).
19 + guard let _ = (scene as? UIWindowScene) else { return }
20 + }
21 +
22 + func sceneDidDisconnect(_ scene: UIScene) {
23 + // Called as the scene is being released by the system.
24 + // This occurs shortly after the scene enters the background, or when its session is discarded.
25 + // Release any resources associated with this scene that can be re-created the next time the scene connects.
26 + // The scene may re-connect later, as its session was not necessarily discarded (see `application:didDiscardSceneSessions` instead).
27 + }
28 +
29 + func sceneDidBecomeActive(_ scene: UIScene) {
30 + // Called when the scene has moved from an inactive state to an active state.
31 + // Use this method to restart any tasks that were paused (or not yet started) when the scene was inactive.
32 + }
33 +
34 + func sceneWillResignActive(_ scene: UIScene) {
35 + // Called when the scene will move from an active state to an inactive state.
36 + // This may occur due to temporary interruptions (ex. an incoming phone call).
37 + }
38 +
39 + func sceneWillEnterForeground(_ scene: UIScene) {
40 + // Called as the scene transitions from the background to the foreground.
41 + // Use this method to undo the changes made on entering the background.
42 + }
43 +
44 + func sceneDidEnterBackground(_ scene: UIScene) {
45 + // Called as the scene transitions from the foreground to the background.
46 + // Use this method to save data, release shared resources, and store enough scene-specific state information
47 + // to restore the scene back to its current state.
48 + }
49 +
50 +
51 +}
52 +
1 +//
2 +// ViewController.swift
3 +// client
4 +//
5 +// Created by 김우재 on 2021/12/10.
6 +//
7 +
8 +import UIKit
9 +import Kingfisher
10 +
11 +enum Constants {
12 + static let endpoint = "http://localhost:3000"
13 + static let getImageURL: (Int) -> URL? = {
14 + return URL(string: "\(endpoint)/images/\($0).jpg")
15 + }
16 + static let postLabelURL: (Int) -> URL? = {
17 + return URL(string: "\(endpoint)/label/\($0)")
18 + }
19 +}
20 +
21 +
22 +class ViewController: UIViewController {
23 +
24 + @IBOutlet weak var imageView: UIImageView!
25 + @IBOutlet weak var prevButton: UIButton!
26 + @IBOutlet weak var nextButton: UIButton!
27 + @IBOutlet weak var currentLabel: UILabel!
28 + @IBOutlet weak var areaView: UIView!
29 +
30 + let images: [Int] = (1...129).map {$0} + (251...750).map {$0}
31 + var currentIndex = 0
32 +
33 + override func viewDidLoad() {
34 + super.viewDidLoad()
35 + // Do any additional setup after loading the view.
36 + setImage(index: currentIndex)
37 + setLabel(index: currentIndex)
38 + areaView.layer.borderWidth = 3.0
39 + areaView.layer.borderColor = UIColor.red.cgColor
40 + imageView.addSubview(areaView)
41 + print(areaView.frame)
42 +
43 + }
44 +
45 + func setImage(index: Int) {
46 + guard 0..<images.count ~= index else { return }
47 + let url = Constants.getImageURL(images[index])
48 + imageView.kf.setImage(with: url)
49 + }
50 +
51 + func setLabel(index: Int) {
52 + currentLabel.text = "\(index + 1) / \(images.count)"
53 + }
54 +
55 + @IBAction func onPrevButtonPressed(_ sender: Any) {
56 + currentIndex -= 1
57 + setImage(index: currentIndex)
58 + setLabel(index: currentIndex)
59 + }
60 + @IBAction func onNextButtonPressed(_ sender: Any) {
61 + currentIndex += 1
62 + setImage(index: currentIndex)
63 + setLabel(index: currentIndex)
64 + }
65 +
66 + var start: CGPoint = CGPoint(x: 0, y: 0)
67 +
68 + @IBAction func panGestureRecognized(_ sender: UIPanGestureRecognizer) {
69 + switch sender.numberOfTouches {
70 + case 1:
71 + switch sender.state {
72 + case .began:
73 + start = areaView.frame.origin
74 + case .changed:
75 + let transform = sender.translation(in: imageView)
76 + areaView.frame.origin = CGPoint(x: start.x + transform.x, y: start.y + transform.y)
77 + default:
78 + return
79 + }
80 +
81 + case 2:
82 + switch sender.state {
83 + case .began, .changed:
84 + let p1 = sender.location(ofTouch: 0, in: imageView)
85 + let p2 = sender.location(ofTouch: 1, in: imageView)
86 + let minX = min(p1.x, p2.x), maxX = max(p1.x, p2.x)
87 + let minY = min(p1.y, p2.y), maxY = max(p1.y, p2.y)
88 + areaView.frame = CGRect(x: minX, y: minY, width: maxX-minX, height: maxY-minY)
89 + default:
90 + return
91 + }
92 +
93 + default:
94 + return
95 + }
96 + }
97 +
98 + @IBAction func onSendButtonPressed(_ sender: Any) {
99 + let center = areaView.center
100 + let size = areaView.frame.size
101 +
102 + let x = (center.x / imageView.frame.width)
103 + let y = center.y / imageView.frame.height
104 + let w = size.width / imageView.frame.width
105 + let h = size.height / imageView.frame.height
106 +
107 + print(rounder(x), rounder(y), rounder(w), rounder(h))
108 + var json = [String: Any]()
109 + json["x"] = rounder(x)
110 + json["y"] = rounder(y)
111 + json["w"] = rounder(w)
112 + json["h"] = rounder(h)
113 + do {
114 + let data = try JSONSerialization.data(withJSONObject: json, options: [])
115 + guard let url = Constants.postLabelURL(images[currentIndex]) else { return }
116 + var request = URLRequest(url: url)
117 + request.httpMethod = "POST"
118 + request.httpBody = data
119 + request.addValue("application/json", forHTTPHeaderField: "Content-Type")
120 + request.addValue("application/json", forHTTPHeaderField: "Accept")
121 + let task = URLSession.shared.dataTask(with: request)
122 + task.resume()
123 + showToast(message: "라벨 데이터 전송 완료!")
124 + } catch {
125 + showToast(message: "전송 실패")
126 + return
127 + }
128 + }
129 +}
130 +
131 +
132 +func rounder(_ num: Double) -> Double {
133 + let multiplier = 1000000
134 + return (num * Double(multiplier)).rounded() / Double(multiplier)
135 +}
136 +
137 +extension UIViewController {
138 +
139 + func showToast(message: String) {
140 + let toastLabel = self.createToastLabel()
141 + toastLabel.backgroundColor = UIColor.black.withAlphaComponent(0.6)
142 + toastLabel.textColor = UIColor.white
143 + toastLabel.font = .systemFont(ofSize: 15)
144 + toastLabel.textAlignment = .center
145 + toastLabel.text = message
146 + toastLabel.numberOfLines = 0
147 + toastLabel.alpha = 1.0
148 + toastLabel.layer.cornerRadius = 10
149 + toastLabel.clipsToBounds = true
150 + self.view.addSubview(toastLabel)
151 + UIView.animate(withDuration: 1.0, delay: 1.0, options: [], animations: {
152 + toastLabel.alpha = 0.0
153 + }, completion: { _ in
154 + toastLabel.removeFromSuperview()
155 + })
156 + }
157 +
158 + private func createToastLabel() -> UILabel {
159 + return UILabel(
160 + frame: CGRect(
161 + x: self.view.frame.size.width / 2 - 75,
162 + y: self.view.frame.size.height - 100,
163 + width: 150,
164 + height: 35
165 + )
166 + )
167 + }
168 +}
1 +var createError = require('http-errors');
2 +var express = require('express');
3 +var path = require('path');
4 +var cookieParser = require('cookie-parser');
5 +var logger = require('morgan');
6 +
7 +var indexRouter = require('./routes/index');
8 +var usersRouter = require('./routes/users');
9 +
10 +var app = express();
11 +
12 +// view engine setup
13 +app.set('views', path.join(__dirname, 'views'));
14 +app.set('view engine', 'ejs');
15 +
16 +app.use(logger('dev'));
17 +app.use(express.json());
18 +app.use(express.urlencoded({ extended: false }));
19 +app.use(cookieParser());
20 +app.use(express.static(path.join(__dirname, 'public')));
21 +
22 +app.use('/', indexRouter);
23 +app.use('/users', usersRouter);
24 +
25 +// catch 404 and forward to error handler
26 +app.use(function(req, res, next) {
27 + next(createError(404));
28 +});
29 +
30 +// error handler
31 +app.use(function(err, req, res, next) {
32 + // set locals, only providing error in development
33 + res.locals.message = err.message;
34 + res.locals.error = req.app.get('env') === 'development' ? err : {};
35 +
36 + // render the error page
37 + res.status(err.status || 500);
38 + res.render('error');
39 +});
40 +
41 +module.exports = app;
1 +#!/usr/bin/env node
2 +
3 +/**
4 + * Module dependencies.
5 + */
6 +
7 +var app = require('../app');
8 +var debug = require('debug')('server:server');
9 +var http = require('http');
10 +
11 +/**
12 + * Get port from environment and store in Express.
13 + */
14 +
15 +var port = normalizePort(process.env.PORT || '3000');
16 +app.set('port', port);
17 +
18 +/**
19 + * Create HTTP server.
20 + */
21 +
22 +var server = http.createServer(app);
23 +
24 +/**
25 + * Listen on provided port, on all network interfaces.
26 + */
27 +
28 +server.listen(port);
29 +server.on('error', onError);
30 +server.on('listening', onListening);
31 +
32 +/**
33 + * Normalize a port into a number, string, or false.
34 + */
35 +
36 +function normalizePort(val) {
37 + var port = parseInt(val, 10);
38 +
39 + if (isNaN(port)) {
40 + // named pipe
41 + return val;
42 + }
43 +
44 + if (port >= 0) {
45 + // port number
46 + return port;
47 + }
48 +
49 + return false;
50 +}
51 +
52 +/**
53 + * Event listener for HTTP server "error" event.
54 + */
55 +
56 +function onError(error) {
57 + if (error.syscall !== 'listen') {
58 + throw error;
59 + }
60 +
61 + var bind = typeof port === 'string'
62 + ? 'Pipe ' + port
63 + : 'Port ' + port;
64 +
65 + // handle specific listen errors with friendly messages
66 + switch (error.code) {
67 + case 'EACCES':
68 + console.error(bind + ' requires elevated privileges');
69 + process.exit(1);
70 + break;
71 + case 'EADDRINUSE':
72 + console.error(bind + ' is already in use');
73 + process.exit(1);
74 + break;
75 + default:
76 + throw error;
77 + }
78 +}
79 +
80 +/**
81 + * Event listener for HTTP server "listening" event.
82 + */
83 +
84 +function onListening() {
85 + var addr = server.address();
86 + var bind = typeof addr === 'string'
87 + ? 'pipe ' + addr
88 + : 'port ' + addr.port;
89 + debug('Listening on ' + bind);
90 +}
1 +../mime/cli.js
...\ No newline at end of file ...\ No newline at end of file
This diff is collapsed. Click to expand it.
1 +1.3.7 / 2019-04-29
2 +==================
3 +
4 + * deps: negotiator@0.6.2
5 + - Fix sorting charset, encoding, and language with extra parameters
6 +
7 +1.3.6 / 2019-04-28
8 +==================
9 +
10 + * deps: mime-types@~2.1.24
11 + - deps: mime-db@~1.40.0
12 +
13 +1.3.5 / 2018-02-28
14 +==================
15 +
16 + * deps: mime-types@~2.1.18
17 + - deps: mime-db@~1.33.0
18 +
19 +1.3.4 / 2017-08-22
20 +==================
21 +
22 + * deps: mime-types@~2.1.16
23 + - deps: mime-db@~1.29.0
24 +
25 +1.3.3 / 2016-05-02
26 +==================
27 +
28 + * deps: mime-types@~2.1.11
29 + - deps: mime-db@~1.23.0
30 + * deps: negotiator@0.6.1
31 + - perf: improve `Accept` parsing speed
32 + - perf: improve `Accept-Charset` parsing speed
33 + - perf: improve `Accept-Encoding` parsing speed
34 + - perf: improve `Accept-Language` parsing speed
35 +
36 +1.3.2 / 2016-03-08
37 +==================
38 +
39 + * deps: mime-types@~2.1.10
40 + - Fix extension of `application/dash+xml`
41 + - Update primary extension for `audio/mp4`
42 + - deps: mime-db@~1.22.0
43 +
44 +1.3.1 / 2016-01-19
45 +==================
46 +
47 + * deps: mime-types@~2.1.9
48 + - deps: mime-db@~1.21.0
49 +
50 +1.3.0 / 2015-09-29
51 +==================
52 +
53 + * deps: mime-types@~2.1.7
54 + - deps: mime-db@~1.19.0
55 + * deps: negotiator@0.6.0
56 + - Fix including type extensions in parameters in `Accept` parsing
57 + - Fix parsing `Accept` parameters with quoted equals
58 + - Fix parsing `Accept` parameters with quoted semicolons
59 + - Lazy-load modules from main entry point
60 + - perf: delay type concatenation until needed
61 + - perf: enable strict mode
62 + - perf: hoist regular expressions
63 + - perf: remove closures getting spec properties
64 + - perf: remove a closure from media type parsing
65 + - perf: remove property delete from media type parsing
66 +
67 +1.2.13 / 2015-09-06
68 +===================
69 +
70 + * deps: mime-types@~2.1.6
71 + - deps: mime-db@~1.18.0
72 +
73 +1.2.12 / 2015-07-30
74 +===================
75 +
76 + * deps: mime-types@~2.1.4
77 + - deps: mime-db@~1.16.0
78 +
79 +1.2.11 / 2015-07-16
80 +===================
81 +
82 + * deps: mime-types@~2.1.3
83 + - deps: mime-db@~1.15.0
84 +
85 +1.2.10 / 2015-07-01
86 +===================
87 +
88 + * deps: mime-types@~2.1.2
89 + - deps: mime-db@~1.14.0
90 +
91 +1.2.9 / 2015-06-08
92 +==================
93 +
94 + * deps: mime-types@~2.1.1
95 + - perf: fix deopt during mapping
96 +
97 +1.2.8 / 2015-06-07
98 +==================
99 +
100 + * deps: mime-types@~2.1.0
101 + - deps: mime-db@~1.13.0
102 + * perf: avoid argument reassignment & argument slice
103 + * perf: avoid negotiator recursive construction
104 + * perf: enable strict mode
105 + * perf: remove unnecessary bitwise operator
106 +
107 +1.2.7 / 2015-05-10
108 +==================
109 +
110 + * deps: negotiator@0.5.3
111 + - Fix media type parameter matching to be case-insensitive
112 +
113 +1.2.6 / 2015-05-07
114 +==================
115 +
116 + * deps: mime-types@~2.0.11
117 + - deps: mime-db@~1.9.1
118 + * deps: negotiator@0.5.2
119 + - Fix comparing media types with quoted values
120 + - Fix splitting media types with quoted commas
121 +
122 +1.2.5 / 2015-03-13
123 +==================
124 +
125 + * deps: mime-types@~2.0.10
126 + - deps: mime-db@~1.8.0
127 +
128 +1.2.4 / 2015-02-14
129 +==================
130 +
131 + * Support Node.js 0.6
132 + * deps: mime-types@~2.0.9
133 + - deps: mime-db@~1.7.0
134 + * deps: negotiator@0.5.1
135 + - Fix preference sorting to be stable for long acceptable lists
136 +
137 +1.2.3 / 2015-01-31
138 +==================
139 +
140 + * deps: mime-types@~2.0.8
141 + - deps: mime-db@~1.6.0
142 +
143 +1.2.2 / 2014-12-30
144 +==================
145 +
146 + * deps: mime-types@~2.0.7
147 + - deps: mime-db@~1.5.0
148 +
149 +1.2.1 / 2014-12-30
150 +==================
151 +
152 + * deps: mime-types@~2.0.5
153 + - deps: mime-db@~1.3.1
154 +
155 +1.2.0 / 2014-12-19
156 +==================
157 +
158 + * deps: negotiator@0.5.0
159 + - Fix list return order when large accepted list
160 + - Fix missing identity encoding when q=0 exists
161 + - Remove dynamic building of Negotiator class
162 +
163 +1.1.4 / 2014-12-10
164 +==================
165 +
166 + * deps: mime-types@~2.0.4
167 + - deps: mime-db@~1.3.0
168 +
169 +1.1.3 / 2014-11-09
170 +==================
171 +
172 + * deps: mime-types@~2.0.3
173 + - deps: mime-db@~1.2.0
174 +
175 +1.1.2 / 2014-10-14
176 +==================
177 +
178 + * deps: negotiator@0.4.9
179 + - Fix error when media type has invalid parameter
180 +
181 +1.1.1 / 2014-09-28
182 +==================
183 +
184 + * deps: mime-types@~2.0.2
185 + - deps: mime-db@~1.1.0
186 + * deps: negotiator@0.4.8
187 + - Fix all negotiations to be case-insensitive
188 + - Stable sort preferences of same quality according to client order
189 +
190 +1.1.0 / 2014-09-02
191 +==================
192 +
193 + * update `mime-types`
194 +
195 +1.0.7 / 2014-07-04
196 +==================
197 +
198 + * Fix wrong type returned from `type` when match after unknown extension
199 +
200 +1.0.6 / 2014-06-24
201 +==================
202 +
203 + * deps: negotiator@0.4.7
204 +
205 +1.0.5 / 2014-06-20
206 +==================
207 +
208 + * fix crash when unknown extension given
209 +
210 +1.0.4 / 2014-06-19
211 +==================
212 +
213 + * use `mime-types`
214 +
215 +1.0.3 / 2014-06-11
216 +==================
217 +
218 + * deps: negotiator@0.4.6
219 + - Order by specificity when quality is the same
220 +
221 +1.0.2 / 2014-05-29
222 +==================
223 +
224 + * Fix interpretation when header not in request
225 + * deps: pin negotiator@0.4.5
226 +
227 +1.0.1 / 2014-01-18
228 +==================
229 +
230 + * Identity encoding isn't always acceptable
231 + * deps: negotiator@~0.4.0
232 +
233 +1.0.0 / 2013-12-27
234 +==================
235 +
236 + * Genesis
1 +(The MIT License)
2 +
3 +Copyright (c) 2014 Jonathan Ong <me@jongleberry.com>
4 +Copyright (c) 2015 Douglas Christopher Wilson <doug@somethingdoug.com>
5 +
6 +Permission is hereby granted, free of charge, to any person obtaining
7 +a copy of this software and associated documentation files (the
8 +'Software'), to deal in the Software without restriction, including
9 +without limitation the rights to use, copy, modify, merge, publish,
10 +distribute, sublicense, and/or sell copies of the Software, and to
11 +permit persons to whom the Software is furnished to do so, subject to
12 +the following conditions:
13 +
14 +The above copyright notice and this permission notice shall be
15 +included in all copies or substantial portions of the Software.
16 +
17 +THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
18 +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19 +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
20 +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
21 +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
22 +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
23 +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
1 +# accepts
2 +
3 +[![NPM Version][npm-version-image]][npm-url]
4 +[![NPM Downloads][npm-downloads-image]][npm-url]
5 +[![Node.js Version][node-version-image]][node-version-url]
6 +[![Build Status][travis-image]][travis-url]
7 +[![Test Coverage][coveralls-image]][coveralls-url]
8 +
9 +Higher level content negotiation based on [negotiator](https://www.npmjs.com/package/negotiator).
10 +Extracted from [koa](https://www.npmjs.com/package/koa) for general use.
11 +
12 +In addition to negotiator, it allows:
13 +
14 +- Allows types as an array or arguments list, ie `(['text/html', 'application/json'])`
15 + as well as `('text/html', 'application/json')`.
16 +- Allows type shorthands such as `json`.
17 +- Returns `false` when no types match
18 +- Treats non-existent headers as `*`
19 +
20 +## Installation
21 +
22 +This is a [Node.js](https://nodejs.org/en/) module available through the
23 +[npm registry](https://www.npmjs.com/). Installation is done using the
24 +[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
25 +
26 +```sh
27 +$ npm install accepts
28 +```
29 +
30 +## API
31 +
32 +<!-- eslint-disable no-unused-vars -->
33 +
34 +```js
35 +var accepts = require('accepts')
36 +```
37 +
38 +### accepts(req)
39 +
40 +Create a new `Accepts` object for the given `req`.
41 +
42 +#### .charset(charsets)
43 +
44 +Return the first accepted charset. If nothing in `charsets` is accepted,
45 +then `false` is returned.
46 +
47 +#### .charsets()
48 +
49 +Return the charsets that the request accepts, in the order of the client's
50 +preference (most preferred first).
51 +
52 +#### .encoding(encodings)
53 +
54 +Return the first accepted encoding. If nothing in `encodings` is accepted,
55 +then `false` is returned.
56 +
57 +#### .encodings()
58 +
59 +Return the encodings that the request accepts, in the order of the client's
60 +preference (most preferred first).
61 +
62 +#### .language(languages)
63 +
64 +Return the first accepted language. If nothing in `languages` is accepted,
65 +then `false` is returned.
66 +
67 +#### .languages()
68 +
69 +Return the languages that the request accepts, in the order of the client's
70 +preference (most preferred first).
71 +
72 +#### .type(types)
73 +
74 +Return the first accepted type (and it is returned as the same text as what
75 +appears in the `types` array). If nothing in `types` is accepted, then `false`
76 +is returned.
77 +
78 +The `types` array can contain full MIME types or file extensions. Any value
79 +that is not a full MIME types is passed to `require('mime-types').lookup`.
80 +
81 +#### .types()
82 +
83 +Return the types that the request accepts, in the order of the client's
84 +preference (most preferred first).
85 +
86 +## Examples
87 +
88 +### Simple type negotiation
89 +
90 +This simple example shows how to use `accepts` to return a different typed
91 +respond body based on what the client wants to accept. The server lists it's
92 +preferences in order and will get back the best match between the client and
93 +server.
94 +
95 +```js
96 +var accepts = require('accepts')
97 +var http = require('http')
98 +
99 +function app (req, res) {
100 + var accept = accepts(req)
101 +
102 + // the order of this list is significant; should be server preferred order
103 + switch (accept.type(['json', 'html'])) {
104 + case 'json':
105 + res.setHeader('Content-Type', 'application/json')
106 + res.write('{"hello":"world!"}')
107 + break
108 + case 'html':
109 + res.setHeader('Content-Type', 'text/html')
110 + res.write('<b>hello, world!</b>')
111 + break
112 + default:
113 + // the fallback is text/plain, so no need to specify it above
114 + res.setHeader('Content-Type', 'text/plain')
115 + res.write('hello, world!')
116 + break
117 + }
118 +
119 + res.end()
120 +}
121 +
122 +http.createServer(app).listen(3000)
123 +```
124 +
125 +You can test this out with the cURL program:
126 +```sh
127 +curl -I -H'Accept: text/html' http://localhost:3000/
128 +```
129 +
130 +## License
131 +
132 +[MIT](LICENSE)
133 +
134 +[coveralls-image]: https://badgen.net/coveralls/c/github/jshttp/accepts/master
135 +[coveralls-url]: https://coveralls.io/r/jshttp/accepts?branch=master
136 +[node-version-image]: https://badgen.net/npm/node/accepts
137 +[node-version-url]: https://nodejs.org/en/download
138 +[npm-downloads-image]: https://badgen.net/npm/dm/accepts
139 +[npm-url]: https://npmjs.org/package/accepts
140 +[npm-version-image]: https://badgen.net/npm/v/accepts
141 +[travis-image]: https://badgen.net/travis/jshttp/accepts/master
142 +[travis-url]: https://travis-ci.org/jshttp/accepts
1 +/*!
2 + * accepts
3 + * Copyright(c) 2014 Jonathan Ong
4 + * Copyright(c) 2015 Douglas Christopher Wilson
5 + * MIT Licensed
6 + */
7 +
8 +'use strict'
9 +
10 +/**
11 + * Module dependencies.
12 + * @private
13 + */
14 +
15 +var Negotiator = require('negotiator')
16 +var mime = require('mime-types')
17 +
18 +/**
19 + * Module exports.
20 + * @public
21 + */
22 +
23 +module.exports = Accepts
24 +
25 +/**
26 + * Create a new Accepts object for the given req.
27 + *
28 + * @param {object} req
29 + * @public
30 + */
31 +
32 +function Accepts (req) {
33 + if (!(this instanceof Accepts)) {
34 + return new Accepts(req)
35 + }
36 +
37 + this.headers = req.headers
38 + this.negotiator = new Negotiator(req)
39 +}
40 +
41 +/**
42 + * Check if the given `type(s)` is acceptable, returning
43 + * the best match when true, otherwise `undefined`, in which
44 + * case you should respond with 406 "Not Acceptable".
45 + *
46 + * The `type` value may be a single mime type string
47 + * such as "application/json", the extension name
48 + * such as "json" or an array `["json", "html", "text/plain"]`. When a list
49 + * or array is given the _best_ match, if any is returned.
50 + *
51 + * Examples:
52 + *
53 + * // Accept: text/html
54 + * this.types('html');
55 + * // => "html"
56 + *
57 + * // Accept: text/*, application/json
58 + * this.types('html');
59 + * // => "html"
60 + * this.types('text/html');
61 + * // => "text/html"
62 + * this.types('json', 'text');
63 + * // => "json"
64 + * this.types('application/json');
65 + * // => "application/json"
66 + *
67 + * // Accept: text/*, application/json
68 + * this.types('image/png');
69 + * this.types('png');
70 + * // => undefined
71 + *
72 + * // Accept: text/*;q=.5, application/json
73 + * this.types(['html', 'json']);
74 + * this.types('html', 'json');
75 + * // => "json"
76 + *
77 + * @param {String|Array} types...
78 + * @return {String|Array|Boolean}
79 + * @public
80 + */
81 +
82 +Accepts.prototype.type =
83 +Accepts.prototype.types = function (types_) {
84 + var types = types_
85 +
86 + // support flattened arguments
87 + if (types && !Array.isArray(types)) {
88 + types = new Array(arguments.length)
89 + for (var i = 0; i < types.length; i++) {
90 + types[i] = arguments[i]
91 + }
92 + }
93 +
94 + // no types, return all requested types
95 + if (!types || types.length === 0) {
96 + return this.negotiator.mediaTypes()
97 + }
98 +
99 + // no accept header, return first given type
100 + if (!this.headers.accept) {
101 + return types[0]
102 + }
103 +
104 + var mimes = types.map(extToMime)
105 + var accepts = this.negotiator.mediaTypes(mimes.filter(validMime))
106 + var first = accepts[0]
107 +
108 + return first
109 + ? types[mimes.indexOf(first)]
110 + : false
111 +}
112 +
113 +/**
114 + * Return accepted encodings or best fit based on `encodings`.
115 + *
116 + * Given `Accept-Encoding: gzip, deflate`
117 + * an array sorted by quality is returned:
118 + *
119 + * ['gzip', 'deflate']
120 + *
121 + * @param {String|Array} encodings...
122 + * @return {String|Array}
123 + * @public
124 + */
125 +
126 +Accepts.prototype.encoding =
127 +Accepts.prototype.encodings = function (encodings_) {
128 + var encodings = encodings_
129 +
130 + // support flattened arguments
131 + if (encodings && !Array.isArray(encodings)) {
132 + encodings = new Array(arguments.length)
133 + for (var i = 0; i < encodings.length; i++) {
134 + encodings[i] = arguments[i]
135 + }
136 + }
137 +
138 + // no encodings, return all requested encodings
139 + if (!encodings || encodings.length === 0) {
140 + return this.negotiator.encodings()
141 + }
142 +
143 + return this.negotiator.encodings(encodings)[0] || false
144 +}
145 +
146 +/**
147 + * Return accepted charsets or best fit based on `charsets`.
148 + *
149 + * Given `Accept-Charset: utf-8, iso-8859-1;q=0.2, utf-7;q=0.5`
150 + * an array sorted by quality is returned:
151 + *
152 + * ['utf-8', 'utf-7', 'iso-8859-1']
153 + *
154 + * @param {String|Array} charsets...
155 + * @return {String|Array}
156 + * @public
157 + */
158 +
159 +Accepts.prototype.charset =
160 +Accepts.prototype.charsets = function (charsets_) {
161 + var charsets = charsets_
162 +
163 + // support flattened arguments
164 + if (charsets && !Array.isArray(charsets)) {
165 + charsets = new Array(arguments.length)
166 + for (var i = 0; i < charsets.length; i++) {
167 + charsets[i] = arguments[i]
168 + }
169 + }
170 +
171 + // no charsets, return all requested charsets
172 + if (!charsets || charsets.length === 0) {
173 + return this.negotiator.charsets()
174 + }
175 +
176 + return this.negotiator.charsets(charsets)[0] || false
177 +}
178 +
179 +/**
180 + * Return accepted languages or best fit based on `langs`.
181 + *
182 + * Given `Accept-Language: en;q=0.8, es, pt`
183 + * an array sorted by quality is returned:
184 + *
185 + * ['es', 'pt', 'en']
186 + *
187 + * @param {String|Array} langs...
188 + * @return {Array|String}
189 + * @public
190 + */
191 +
192 +Accepts.prototype.lang =
193 +Accepts.prototype.langs =
194 +Accepts.prototype.language =
195 +Accepts.prototype.languages = function (languages_) {
196 + var languages = languages_
197 +
198 + // support flattened arguments
199 + if (languages && !Array.isArray(languages)) {
200 + languages = new Array(arguments.length)
201 + for (var i = 0; i < languages.length; i++) {
202 + languages[i] = arguments[i]
203 + }
204 + }
205 +
206 + // no languages, return all requested languages
207 + if (!languages || languages.length === 0) {
208 + return this.negotiator.languages()
209 + }
210 +
211 + return this.negotiator.languages(languages)[0] || false
212 +}
213 +
214 +/**
215 + * Convert extnames to mime.
216 + *
217 + * @param {String} type
218 + * @return {String}
219 + * @private
220 + */
221 +
222 +function extToMime (type) {
223 + return type.indexOf('/') === -1
224 + ? mime.lookup(type)
225 + : type
226 +}
227 +
228 +/**
229 + * Check if mime is valid.
230 + *
231 + * @param {String} type
232 + * @return {String}
233 + * @private
234 + */
235 +
236 +function validMime (type) {
237 + return typeof type === 'string'
238 +}
1 +{
2 + "name": "accepts",
3 + "description": "Higher-level content negotiation",
4 + "version": "1.3.7",
5 + "contributors": [
6 + "Douglas Christopher Wilson <doug@somethingdoug.com>",
7 + "Jonathan Ong <me@jongleberry.com> (http://jongleberry.com)"
8 + ],
9 + "license": "MIT",
10 + "repository": "jshttp/accepts",
11 + "dependencies": {
12 + "mime-types": "~2.1.24",
13 + "negotiator": "0.6.2"
14 + },
15 + "devDependencies": {
16 + "deep-equal": "1.0.1",
17 + "eslint": "5.16.0",
18 + "eslint-config-standard": "12.0.0",
19 + "eslint-plugin-import": "2.17.2",
20 + "eslint-plugin-markdown": "1.0.0",
21 + "eslint-plugin-node": "8.0.1",
22 + "eslint-plugin-promise": "4.1.1",
23 + "eslint-plugin-standard": "4.0.0",
24 + "mocha": "6.1.4",
25 + "nyc": "14.0.0"
26 + },
27 + "files": [
28 + "LICENSE",
29 + "HISTORY.md",
30 + "index.js"
31 + ],
32 + "engines": {
33 + "node": ">= 0.6"
34 + },
35 + "scripts": {
36 + "lint": "eslint --plugin markdown --ext js,md .",
37 + "test": "mocha --reporter spec --check-leaks --bail test/",
38 + "test-cov": "nyc --reporter=html --reporter=text npm test",
39 + "test-travis": "nyc --reporter=text npm test"
40 + },
41 + "keywords": [
42 + "content",
43 + "negotiation",
44 + "accept",
45 + "accepts"
46 + ]
47 +}
1 +The MIT License (MIT)
2 +
3 +Copyright (c) 2014 Blake Embrey (hello@blakeembrey.com)
4 +
5 +Permission is hereby granted, free of charge, to any person obtaining a copy
6 +of this software and associated documentation files (the "Software"), to deal
7 +in the Software without restriction, including without limitation the rights
8 +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 +copies of the Software, and to permit persons to whom the Software is
10 +furnished to do so, subject to the following conditions:
11 +
12 +The above copyright notice and this permission notice shall be included in
13 +all copies or substantial portions of the Software.
14 +
15 +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21 +THE SOFTWARE.
1 +# Array Flatten
2 +
3 +[![NPM version][npm-image]][npm-url]
4 +[![NPM downloads][downloads-image]][downloads-url]
5 +[![Build status][travis-image]][travis-url]
6 +[![Test coverage][coveralls-image]][coveralls-url]
7 +
8 +> Flatten an array of nested arrays into a single flat array. Accepts an optional depth.
9 +
10 +## Installation
11 +
12 +```
13 +npm install array-flatten --save
14 +```
15 +
16 +## Usage
17 +
18 +```javascript
19 +var flatten = require('array-flatten')
20 +
21 +flatten([1, [2, [3, [4, [5], 6], 7], 8], 9])
22 +//=> [1, 2, 3, 4, 5, 6, 7, 8, 9]
23 +
24 +flatten([1, [2, [3, [4, [5], 6], 7], 8], 9], 2)
25 +//=> [1, 2, 3, [4, [5], 6], 7, 8, 9]
26 +
27 +(function () {
28 + flatten(arguments) //=> [1, 2, 3]
29 +})(1, [2, 3])
30 +```
31 +
32 +## License
33 +
34 +MIT
35 +
36 +[npm-image]: https://img.shields.io/npm/v/array-flatten.svg?style=flat
37 +[npm-url]: https://npmjs.org/package/array-flatten
38 +[downloads-image]: https://img.shields.io/npm/dm/array-flatten.svg?style=flat
39 +[downloads-url]: https://npmjs.org/package/array-flatten
40 +[travis-image]: https://img.shields.io/travis/blakeembrey/array-flatten.svg?style=flat
41 +[travis-url]: https://travis-ci.org/blakeembrey/array-flatten
42 +[coveralls-image]: https://img.shields.io/coveralls/blakeembrey/array-flatten.svg?style=flat
43 +[coveralls-url]: https://coveralls.io/r/blakeembrey/array-flatten?branch=master
1 +'use strict'
2 +
3 +/**
4 + * Expose `arrayFlatten`.
5 + */
6 +module.exports = arrayFlatten
7 +
8 +/**
9 + * Recursive flatten function with depth.
10 + *
11 + * @param {Array} array
12 + * @param {Array} result
13 + * @param {Number} depth
14 + * @return {Array}
15 + */
16 +function flattenWithDepth (array, result, depth) {
17 + for (var i = 0; i < array.length; i++) {
18 + var value = array[i]
19 +
20 + if (depth > 0 && Array.isArray(value)) {
21 + flattenWithDepth(value, result, depth - 1)
22 + } else {
23 + result.push(value)
24 + }
25 + }
26 +
27 + return result
28 +}
29 +
30 +/**
31 + * Recursive flatten function. Omitting depth is slightly faster.
32 + *
33 + * @param {Array} array
34 + * @param {Array} result
35 + * @return {Array}
36 + */
37 +function flattenForever (array, result) {
38 + for (var i = 0; i < array.length; i++) {
39 + var value = array[i]
40 +
41 + if (Array.isArray(value)) {
42 + flattenForever(value, result)
43 + } else {
44 + result.push(value)
45 + }
46 + }
47 +
48 + return result
49 +}
50 +
51 +/**
52 + * Flatten an array, with the ability to define a depth.
53 + *
54 + * @param {Array} array
55 + * @param {Number} depth
56 + * @return {Array}
57 + */
58 +function arrayFlatten (array, depth) {
59 + if (depth == null) {
60 + return flattenForever(array, [])
61 + }
62 +
63 + return flattenWithDepth(array, [], depth)
64 +}
1 +{
2 + "name": "array-flatten",
3 + "version": "1.1.1",
4 + "description": "Flatten an array of nested arrays into a single flat array",
5 + "main": "array-flatten.js",
6 + "files": [
7 + "array-flatten.js",
8 + "LICENSE"
9 + ],
10 + "scripts": {
11 + "test": "istanbul cover _mocha -- -R spec"
12 + },
13 + "repository": {
14 + "type": "git",
15 + "url": "git://github.com/blakeembrey/array-flatten.git"
16 + },
17 + "keywords": [
18 + "array",
19 + "flatten",
20 + "arguments",
21 + "depth"
22 + ],
23 + "author": {
24 + "name": "Blake Embrey",
25 + "email": "hello@blakeembrey.com",
26 + "url": "http://blakeembrey.me"
27 + },
28 + "license": "MIT",
29 + "bugs": {
30 + "url": "https://github.com/blakeembrey/array-flatten/issues"
31 + },
32 + "homepage": "https://github.com/blakeembrey/array-flatten",
33 + "devDependencies": {
34 + "istanbul": "^0.3.13",
35 + "mocha": "^2.2.4",
36 + "pre-commit": "^1.0.7",
37 + "standard": "^3.7.3"
38 + }
39 +}
1 +2.0.1 / 2018-09-19
2 +==================
3 +
4 + * deps: safe-buffer@5.1.2
5 +
6 +2.0.0 / 2017-09-12
7 +==================
8 +
9 + * Drop support for Node.js below 0.8
10 + * Remove `auth(ctx)` signature -- pass in header or `auth(ctx.req)`
11 + * Use `safe-buffer` for improved Buffer API
12 +
13 +1.1.0 / 2016-11-18
14 +==================
15 +
16 + * Add `auth.parse` for low-level string parsing
17 +
18 +1.0.4 / 2016-05-10
19 +==================
20 +
21 + * Improve error message when `req` argument is not an object
22 + * Improve error message when `req` missing `headers` property
23 +
24 +1.0.3 / 2015-07-01
25 +==================
26 +
27 + * Fix regression accepting a Koa context
28 +
29 +1.0.2 / 2015-06-12
30 +==================
31 +
32 + * Improve error message when `req` argument missing
33 + * perf: enable strict mode
34 + * perf: hoist regular expression
35 + * perf: parse with regular expressions
36 + * perf: remove argument reassignment
37 +
38 +1.0.1 / 2015-05-04
39 +==================
40 +
41 + * Update readme
42 +
43 +1.0.0 / 2014-07-01
44 +==================
45 +
46 + * Support empty password
47 + * Support empty username
48 +
49 +0.0.1 / 2013-11-30
50 +==================
51 +
52 + * Initial release
1 +(The MIT License)
2 +
3 +Copyright (c) 2013 TJ Holowaychuk
4 +Copyright (c) 2014 Jonathan Ong <me@jongleberry.com>
5 +Copyright (c) 2015-2016 Douglas Christopher Wilson <doug@somethingdoug.com>
6 +
7 +Permission is hereby granted, free of charge, to any person obtaining
8 +a copy of this software and associated documentation files (the
9 +'Software'), to deal in the Software without restriction, including
10 +without limitation the rights to use, copy, modify, merge, publish,
11 +distribute, sublicense, and/or sell copies of the Software, and to
12 +permit persons to whom the Software is furnished to do so, subject to
13 +the following conditions:
14 +
15 +The above copyright notice and this permission notice shall be
16 +included in all copies or substantial portions of the Software.
17 +
18 +THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
19 +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20 +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
21 +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
22 +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23 +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24 +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
1 +# basic-auth
2 +
3 +[![NPM Version][npm-image]][npm-url]
4 +[![NPM Downloads][downloads-image]][downloads-url]
5 +[![Node.js Version][node-version-image]][node-version-url]
6 +[![Build Status][travis-image]][travis-url]
7 +[![Test Coverage][coveralls-image]][coveralls-url]
8 +
9 +Generic basic auth Authorization header field parser for whatever.
10 +
11 +## Installation
12 +
13 +This is a [Node.js](https://nodejs.org/en/) module available through the
14 +[npm registry](https://www.npmjs.com/). Installation is done using the
15 +[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
16 +
17 +```
18 +$ npm install basic-auth
19 +```
20 +
21 +## API
22 +
23 +<!-- eslint-disable no-unused-vars -->
24 +
25 +```js
26 +var auth = require('basic-auth')
27 +```
28 +
29 +### auth(req)
30 +
31 +Get the basic auth credentials from the given request. The `Authorization`
32 +header is parsed and if the header is invalid, `undefined` is returned,
33 +otherwise an object with `name` and `pass` properties.
34 +
35 +### auth.parse(string)
36 +
37 +Parse a basic auth authorization header string. This will return an object
38 +with `name` and `pass` properties, or `undefined` if the string is invalid.
39 +
40 +## Example
41 +
42 +Pass a Node.js request object to the module export. If parsing fails
43 +`undefined` is returned, otherwise an object with `.name` and `.pass`.
44 +
45 +<!-- eslint-disable no-unused-vars, no-undef -->
46 +
47 +```js
48 +var auth = require('basic-auth')
49 +var user = auth(req)
50 +// => { name: 'something', pass: 'whatever' }
51 +```
52 +
53 +A header string from any other location can also be parsed with
54 +`auth.parse`, for example a `Proxy-Authorization` header:
55 +
56 +<!-- eslint-disable no-unused-vars, no-undef -->
57 +
58 +```js
59 +var auth = require('basic-auth')
60 +var user = auth.parse(req.getHeader('Proxy-Authorization'))
61 +```
62 +
63 +### With vanilla node.js http server
64 +
65 +```js
66 +var http = require('http')
67 +var auth = require('basic-auth')
68 +var compare = require('tsscmp')
69 +
70 +// Create server
71 +var server = http.createServer(function (req, res) {
72 + var credentials = auth(req)
73 +
74 + // Check credentials
75 + // The "check" function will typically be against your user store
76 + if (!credentials || !check(credentials.name, credentials.pass)) {
77 + res.statusCode = 401
78 + res.setHeader('WWW-Authenticate', 'Basic realm="example"')
79 + res.end('Access denied')
80 + } else {
81 + res.end('Access granted')
82 + }
83 +})
84 +
85 +// Basic function to validate credentials for example
86 +function check (name, pass) {
87 + var valid = true
88 +
89 + // Simple method to prevent short-circut and use timing-safe compare
90 + valid = compare(name, 'john') && valid
91 + valid = compare(pass, 'secret') && valid
92 +
93 + return valid
94 +}
95 +
96 +// Listen
97 +server.listen(3000)
98 +```
99 +
100 +# License
101 +
102 +[MIT](LICENSE)
103 +
104 +[coveralls-image]: https://badgen.net/coveralls/c/github/jshttp/basic-auth/master
105 +[coveralls-url]: https://coveralls.io/r/jshttp/basic-auth?branch=master
106 +[downloads-image]: https://badgen.net/npm/dm/basic-auth
107 +[downloads-url]: https://npmjs.org/package/basic-auth
108 +[node-version-image]: https://badgen.net/npm/node/basic-auth
109 +[node-version-url]: https://nodejs.org/en/download
110 +[npm-image]: https://badgen.net/npm/v/basic-auth
111 +[npm-url]: https://npmjs.org/package/basic-auth
112 +[travis-image]: https://badgen.net/travis/jshttp/basic-auth/master
113 +[travis-url]: https://travis-ci.org/jshttp/basic-auth
1 +/*!
2 + * basic-auth
3 + * Copyright(c) 2013 TJ Holowaychuk
4 + * Copyright(c) 2014 Jonathan Ong
5 + * Copyright(c) 2015-2016 Douglas Christopher Wilson
6 + * MIT Licensed
7 + */
8 +
9 +'use strict'
10 +
11 +/**
12 + * Module dependencies.
13 + * @private
14 + */
15 +
16 +var Buffer = require('safe-buffer').Buffer
17 +
18 +/**
19 + * Module exports.
20 + * @public
21 + */
22 +
23 +module.exports = auth
24 +module.exports.parse = parse
25 +
26 +/**
27 + * RegExp for basic auth credentials
28 + *
29 + * credentials = auth-scheme 1*SP token68
30 + * auth-scheme = "Basic" ; case insensitive
31 + * token68 = 1*( ALPHA / DIGIT / "-" / "." / "_" / "~" / "+" / "/" ) *"="
32 + * @private
33 + */
34 +
35 +var CREDENTIALS_REGEXP = /^ *(?:[Bb][Aa][Ss][Ii][Cc]) +([A-Za-z0-9._~+/-]+=*) *$/
36 +
37 +/**
38 + * RegExp for basic auth user/pass
39 + *
40 + * user-pass = userid ":" password
41 + * userid = *<TEXT excluding ":">
42 + * password = *TEXT
43 + * @private
44 + */
45 +
46 +var USER_PASS_REGEXP = /^([^:]*):(.*)$/
47 +
48 +/**
49 + * Parse the Authorization header field of a request.
50 + *
51 + * @param {object} req
52 + * @return {object} with .name and .pass
53 + * @public
54 + */
55 +
56 +function auth (req) {
57 + if (!req) {
58 + throw new TypeError('argument req is required')
59 + }
60 +
61 + if (typeof req !== 'object') {
62 + throw new TypeError('argument req is required to be an object')
63 + }
64 +
65 + // get header
66 + var header = getAuthorization(req)
67 +
68 + // parse header
69 + return parse(header)
70 +}
71 +
72 +/**
73 + * Decode base64 string.
74 + * @private
75 + */
76 +
77 +function decodeBase64 (str) {
78 + return Buffer.from(str, 'base64').toString()
79 +}
80 +
81 +/**
82 + * Get the Authorization header from request object.
83 + * @private
84 + */
85 +
86 +function getAuthorization (req) {
87 + if (!req.headers || typeof req.headers !== 'object') {
88 + throw new TypeError('argument req is required to have headers property')
89 + }
90 +
91 + return req.headers.authorization
92 +}
93 +
94 +/**
95 + * Parse basic auth to object.
96 + *
97 + * @param {string} string
98 + * @return {object}
99 + * @public
100 + */
101 +
102 +function parse (string) {
103 + if (typeof string !== 'string') {
104 + return undefined
105 + }
106 +
107 + // parse header
108 + var match = CREDENTIALS_REGEXP.exec(string)
109 +
110 + if (!match) {
111 + return undefined
112 + }
113 +
114 + // decode user pass
115 + var userPass = USER_PASS_REGEXP.exec(decodeBase64(match[1]))
116 +
117 + if (!userPass) {
118 + return undefined
119 + }
120 +
121 + // return credentials object
122 + return new Credentials(userPass[1], userPass[2])
123 +}
124 +
125 +/**
126 + * Object to represent user credentials.
127 + * @private
128 + */
129 +
130 +function Credentials (name, pass) {
131 + this.name = name
132 + this.pass = pass
133 +}
1 +{
2 + "name": "basic-auth",
3 + "description": "node.js basic auth parser",
4 + "version": "2.0.1",
5 + "license": "MIT",
6 + "keywords": [
7 + "basic",
8 + "auth",
9 + "authorization",
10 + "basicauth"
11 + ],
12 + "repository": "jshttp/basic-auth",
13 + "dependencies": {
14 + "safe-buffer": "5.1.2"
15 + },
16 + "devDependencies": {
17 + "eslint": "5.6.0",
18 + "eslint-config-standard": "12.0.0",
19 + "eslint-plugin-import": "2.14.0",
20 + "eslint-plugin-markdown": "1.0.0-beta.6",
21 + "eslint-plugin-node": "7.0.1",
22 + "eslint-plugin-promise": "4.0.1",
23 + "eslint-plugin-standard": "4.0.0",
24 + "istanbul": "0.4.5",
25 + "mocha": "5.2.0"
26 + },
27 + "files": [
28 + "HISTORY.md",
29 + "LICENSE",
30 + "index.js"
31 + ],
32 + "engines": {
33 + "node": ">= 0.8"
34 + },
35 + "scripts": {
36 + "lint": "eslint --plugin markdown --ext js,md .",
37 + "test": "mocha --check-leaks --reporter spec --bail",
38 + "test-cov": "istanbul cover node_modules/mocha/bin/_mocha -- --reporter dot --check-leaks test/",
39 + "test-travis": "istanbul cover node_modules/mocha/bin/_mocha --report lcovonly -- --reporter spec --check-leaks test/"
40 + }
41 +}
This diff is collapsed. Click to expand it.
1 +(The MIT License)
2 +
3 +Copyright (c) 2014 Jonathan Ong <me@jongleberry.com>
4 +Copyright (c) 2014-2015 Douglas Christopher Wilson <doug@somethingdoug.com>
5 +
6 +Permission is hereby granted, free of charge, to any person obtaining
7 +a copy of this software and associated documentation files (the
8 +'Software'), to deal in the Software without restriction, including
9 +without limitation the rights to use, copy, modify, merge, publish,
10 +distribute, sublicense, and/or sell copies of the Software, and to
11 +permit persons to whom the Software is furnished to do so, subject to
12 +the following conditions:
13 +
14 +The above copyright notice and this permission notice shall be
15 +included in all copies or substantial portions of the Software.
16 +
17 +THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
18 +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19 +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
20 +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
21 +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
22 +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
23 +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
This diff is collapsed. Click to expand it.
1 +/*!
2 + * body-parser
3 + * Copyright(c) 2014-2015 Douglas Christopher Wilson
4 + * MIT Licensed
5 + */
6 +
7 +'use strict'
8 +
9 +/**
10 + * Module dependencies.
11 + * @private
12 + */
13 +
14 +var deprecate = require('depd')('body-parser')
15 +
16 +/**
17 + * Cache of loaded parsers.
18 + * @private
19 + */
20 +
21 +var parsers = Object.create(null)
22 +
23 +/**
24 + * @typedef Parsers
25 + * @type {function}
26 + * @property {function} json
27 + * @property {function} raw
28 + * @property {function} text
29 + * @property {function} urlencoded
30 + */
31 +
32 +/**
33 + * Module exports.
34 + * @type {Parsers}
35 + */
36 +
37 +exports = module.exports = deprecate.function(bodyParser,
38 + 'bodyParser: use individual json/urlencoded middlewares')
39 +
40 +/**
41 + * JSON parser.
42 + * @public
43 + */
44 +
45 +Object.defineProperty(exports, 'json', {
46 + configurable: true,
47 + enumerable: true,
48 + get: createParserGetter('json')
49 +})
50 +
51 +/**
52 + * Raw parser.
53 + * @public
54 + */
55 +
56 +Object.defineProperty(exports, 'raw', {
57 + configurable: true,
58 + enumerable: true,
59 + get: createParserGetter('raw')
60 +})
61 +
62 +/**
63 + * Text parser.
64 + * @public
65 + */
66 +
67 +Object.defineProperty(exports, 'text', {
68 + configurable: true,
69 + enumerable: true,
70 + get: createParserGetter('text')
71 +})
72 +
73 +/**
74 + * URL-encoded parser.
75 + * @public
76 + */
77 +
78 +Object.defineProperty(exports, 'urlencoded', {
79 + configurable: true,
80 + enumerable: true,
81 + get: createParserGetter('urlencoded')
82 +})
83 +
84 +/**
85 + * Create a middleware to parse json and urlencoded bodies.
86 + *
87 + * @param {object} [options]
88 + * @return {function}
89 + * @deprecated
90 + * @public
91 + */
92 +
93 +function bodyParser (options) {
94 + var opts = {}
95 +
96 + // exclude type option
97 + if (options) {
98 + for (var prop in options) {
99 + if (prop !== 'type') {
100 + opts[prop] = options[prop]
101 + }
102 + }
103 + }
104 +
105 + var _urlencoded = exports.urlencoded(opts)
106 + var _json = exports.json(opts)
107 +
108 + return function bodyParser (req, res, next) {
109 + _json(req, res, function (err) {
110 + if (err) return next(err)
111 + _urlencoded(req, res, next)
112 + })
113 + }
114 +}
115 +
116 +/**
117 + * Create a getter for loading a parser.
118 + * @private
119 + */
120 +
121 +function createParserGetter (name) {
122 + return function get () {
123 + return loadParser(name)
124 + }
125 +}
126 +
127 +/**
128 + * Load a parser module.
129 + * @private
130 + */
131 +
132 +function loadParser (parserName) {
133 + var parser = parsers[parserName]
134 +
135 + if (parser !== undefined) {
136 + return parser
137 + }
138 +
139 + // this uses a switch for static require analysis
140 + switch (parserName) {
141 + case 'json':
142 + parser = require('./lib/types/json')
143 + break
144 + case 'raw':
145 + parser = require('./lib/types/raw')
146 + break
147 + case 'text':
148 + parser = require('./lib/types/text')
149 + break
150 + case 'urlencoded':
151 + parser = require('./lib/types/urlencoded')
152 + break
153 + }
154 +
155 + // store to prevent invoking require()
156 + return (parsers[parserName] = parser)
157 +}
1 +/*!
2 + * body-parser
3 + * Copyright(c) 2014-2015 Douglas Christopher Wilson
4 + * MIT Licensed
5 + */
6 +
7 +'use strict'
8 +
9 +/**
10 + * Module dependencies.
11 + * @private
12 + */
13 +
14 +var createError = require('http-errors')
15 +var getBody = require('raw-body')
16 +var iconv = require('iconv-lite')
17 +var onFinished = require('on-finished')
18 +var zlib = require('zlib')
19 +
20 +/**
21 + * Module exports.
22 + */
23 +
24 +module.exports = read
25 +
26 +/**
27 + * Read a request into a buffer and parse.
28 + *
29 + * @param {object} req
30 + * @param {object} res
31 + * @param {function} next
32 + * @param {function} parse
33 + * @param {function} debug
34 + * @param {object} options
35 + * @private
36 + */
37 +
38 +function read (req, res, next, parse, debug, options) {
39 + var length
40 + var opts = options
41 + var stream
42 +
43 + // flag as parsed
44 + req._body = true
45 +
46 + // read options
47 + var encoding = opts.encoding !== null
48 + ? opts.encoding
49 + : null
50 + var verify = opts.verify
51 +
52 + try {
53 + // get the content stream
54 + stream = contentstream(req, debug, opts.inflate)
55 + length = stream.length
56 + stream.length = undefined
57 + } catch (err) {
58 + return next(err)
59 + }
60 +
61 + // set raw-body options
62 + opts.length = length
63 + opts.encoding = verify
64 + ? null
65 + : encoding
66 +
67 + // assert charset is supported
68 + if (opts.encoding === null && encoding !== null && !iconv.encodingExists(encoding)) {
69 + return next(createError(415, 'unsupported charset "' + encoding.toUpperCase() + '"', {
70 + charset: encoding.toLowerCase(),
71 + type: 'charset.unsupported'
72 + }))
73 + }
74 +
75 + // read body
76 + debug('read body')
77 + getBody(stream, opts, function (error, body) {
78 + if (error) {
79 + var _error
80 +
81 + if (error.type === 'encoding.unsupported') {
82 + // echo back charset
83 + _error = createError(415, 'unsupported charset "' + encoding.toUpperCase() + '"', {
84 + charset: encoding.toLowerCase(),
85 + type: 'charset.unsupported'
86 + })
87 + } else {
88 + // set status code on error
89 + _error = createError(400, error)
90 + }
91 +
92 + // read off entire request
93 + stream.resume()
94 + onFinished(req, function onfinished () {
95 + next(createError(400, _error))
96 + })
97 + return
98 + }
99 +
100 + // verify
101 + if (verify) {
102 + try {
103 + debug('verify body')
104 + verify(req, res, body, encoding)
105 + } catch (err) {
106 + next(createError(403, err, {
107 + body: body,
108 + type: err.type || 'entity.verify.failed'
109 + }))
110 + return
111 + }
112 + }
113 +
114 + // parse
115 + var str = body
116 + try {
117 + debug('parse body')
118 + str = typeof body !== 'string' && encoding !== null
119 + ? iconv.decode(body, encoding)
120 + : body
121 + req.body = parse(str)
122 + } catch (err) {
123 + next(createError(400, err, {
124 + body: str,
125 + type: err.type || 'entity.parse.failed'
126 + }))
127 + return
128 + }
129 +
130 + next()
131 + })
132 +}
133 +
134 +/**
135 + * Get the content stream of the request.
136 + *
137 + * @param {object} req
138 + * @param {function} debug
139 + * @param {boolean} [inflate=true]
140 + * @return {object}
141 + * @api private
142 + */
143 +
144 +function contentstream (req, debug, inflate) {
145 + var encoding = (req.headers['content-encoding'] || 'identity').toLowerCase()
146 + var length = req.headers['content-length']
147 + var stream
148 +
149 + debug('content-encoding "%s"', encoding)
150 +
151 + if (inflate === false && encoding !== 'identity') {
152 + throw createError(415, 'content encoding unsupported', {
153 + encoding: encoding,
154 + type: 'encoding.unsupported'
155 + })
156 + }
157 +
158 + switch (encoding) {
159 + case 'deflate':
160 + stream = zlib.createInflate()
161 + debug('inflate body')
162 + req.pipe(stream)
163 + break
164 + case 'gzip':
165 + stream = zlib.createGunzip()
166 + debug('gunzip body')
167 + req.pipe(stream)
168 + break
169 + case 'identity':
170 + stream = req
171 + stream.length = length
172 + break
173 + default:
174 + throw createError(415, 'unsupported content encoding "' + encoding + '"', {
175 + encoding: encoding,
176 + type: 'encoding.unsupported'
177 + })
178 + }
179 +
180 + return stream
181 +}
1 +/*!
2 + * body-parser
3 + * Copyright(c) 2014 Jonathan Ong
4 + * Copyright(c) 2014-2015 Douglas Christopher Wilson
5 + * MIT Licensed
6 + */
7 +
8 +'use strict'
9 +
10 +/**
11 + * Module dependencies.
12 + * @private
13 + */
14 +
15 +var bytes = require('bytes')
16 +var contentType = require('content-type')
17 +var createError = require('http-errors')
18 +var debug = require('debug')('body-parser:json')
19 +var read = require('../read')
20 +var typeis = require('type-is')
21 +
22 +/**
23 + * Module exports.
24 + */
25 +
26 +module.exports = json
27 +
28 +/**
29 + * RegExp to match the first non-space in a string.
30 + *
31 + * Allowed whitespace is defined in RFC 7159:
32 + *
33 + * ws = *(
34 + * %x20 / ; Space
35 + * %x09 / ; Horizontal tab
36 + * %x0A / ; Line feed or New line
37 + * %x0D ) ; Carriage return
38 + */
39 +
40 +var FIRST_CHAR_REGEXP = /^[\x20\x09\x0a\x0d]*(.)/ // eslint-disable-line no-control-regex
41 +
42 +/**
43 + * Create a middleware to parse JSON bodies.
44 + *
45 + * @param {object} [options]
46 + * @return {function}
47 + * @public
48 + */
49 +
50 +function json (options) {
51 + var opts = options || {}
52 +
53 + var limit = typeof opts.limit !== 'number'
54 + ? bytes.parse(opts.limit || '100kb')
55 + : opts.limit
56 + var inflate = opts.inflate !== false
57 + var reviver = opts.reviver
58 + var strict = opts.strict !== false
59 + var type = opts.type || 'application/json'
60 + var verify = opts.verify || false
61 +
62 + if (verify !== false && typeof verify !== 'function') {
63 + throw new TypeError('option verify must be function')
64 + }
65 +
66 + // create the appropriate type checking function
67 + var shouldParse = typeof type !== 'function'
68 + ? typeChecker(type)
69 + : type
70 +
71 + function parse (body) {
72 + if (body.length === 0) {
73 + // special-case empty json body, as it's a common client-side mistake
74 + // TODO: maybe make this configurable or part of "strict" option
75 + return {}
76 + }
77 +
78 + if (strict) {
79 + var first = firstchar(body)
80 +
81 + if (first !== '{' && first !== '[') {
82 + debug('strict violation')
83 + throw createStrictSyntaxError(body, first)
84 + }
85 + }
86 +
87 + try {
88 + debug('parse json')
89 + return JSON.parse(body, reviver)
90 + } catch (e) {
91 + throw normalizeJsonSyntaxError(e, {
92 + message: e.message,
93 + stack: e.stack
94 + })
95 + }
96 + }
97 +
98 + return function jsonParser (req, res, next) {
99 + if (req._body) {
100 + debug('body already parsed')
101 + next()
102 + return
103 + }
104 +
105 + req.body = req.body || {}
106 +
107 + // skip requests without bodies
108 + if (!typeis.hasBody(req)) {
109 + debug('skip empty body')
110 + next()
111 + return
112 + }
113 +
114 + debug('content-type %j', req.headers['content-type'])
115 +
116 + // determine if request should be parsed
117 + if (!shouldParse(req)) {
118 + debug('skip parsing')
119 + next()
120 + return
121 + }
122 +
123 + // assert charset per RFC 7159 sec 8.1
124 + var charset = getCharset(req) || 'utf-8'
125 + if (charset.substr(0, 4) !== 'utf-') {
126 + debug('invalid charset')
127 + next(createError(415, 'unsupported charset "' + charset.toUpperCase() + '"', {
128 + charset: charset,
129 + type: 'charset.unsupported'
130 + }))
131 + return
132 + }
133 +
134 + // read
135 + read(req, res, next, parse, debug, {
136 + encoding: charset,
137 + inflate: inflate,
138 + limit: limit,
139 + verify: verify
140 + })
141 + }
142 +}
143 +
144 +/**
145 + * Create strict violation syntax error matching native error.
146 + *
147 + * @param {string} str
148 + * @param {string} char
149 + * @return {Error}
150 + * @private
151 + */
152 +
153 +function createStrictSyntaxError (str, char) {
154 + var index = str.indexOf(char)
155 + var partial = str.substring(0, index) + '#'
156 +
157 + try {
158 + JSON.parse(partial); /* istanbul ignore next */ throw new SyntaxError('strict violation')
159 + } catch (e) {
160 + return normalizeJsonSyntaxError(e, {
161 + message: e.message.replace('#', char),
162 + stack: e.stack
163 + })
164 + }
165 +}
166 +
167 +/**
168 + * Get the first non-whitespace character in a string.
169 + *
170 + * @param {string} str
171 + * @return {function}
172 + * @private
173 + */
174 +
175 +function firstchar (str) {
176 + return FIRST_CHAR_REGEXP.exec(str)[1]
177 +}
178 +
179 +/**
180 + * Get the charset of a request.
181 + *
182 + * @param {object} req
183 + * @api private
184 + */
185 +
186 +function getCharset (req) {
187 + try {
188 + return (contentType.parse(req).parameters.charset || '').toLowerCase()
189 + } catch (e) {
190 + return undefined
191 + }
192 +}
193 +
194 +/**
195 + * Normalize a SyntaxError for JSON.parse.
196 + *
197 + * @param {SyntaxError} error
198 + * @param {object} obj
199 + * @return {SyntaxError}
200 + */
201 +
202 +function normalizeJsonSyntaxError (error, obj) {
203 + var keys = Object.getOwnPropertyNames(error)
204 +
205 + for (var i = 0; i < keys.length; i++) {
206 + var key = keys[i]
207 + if (key !== 'stack' && key !== 'message') {
208 + delete error[key]
209 + }
210 + }
211 +
212 + // replace stack before message for Node.js 0.10 and below
213 + error.stack = obj.stack.replace(error.message, obj.message)
214 + error.message = obj.message
215 +
216 + return error
217 +}
218 +
219 +/**
220 + * Get the simple type checker.
221 + *
222 + * @param {string} type
223 + * @return {function}
224 + */
225 +
226 +function typeChecker (type) {
227 + return function checkType (req) {
228 + return Boolean(typeis(req, type))
229 + }
230 +}
1 +/*!
2 + * body-parser
3 + * Copyright(c) 2014-2015 Douglas Christopher Wilson
4 + * MIT Licensed
5 + */
6 +
7 +'use strict'
8 +
9 +/**
10 + * Module dependencies.
11 + */
12 +
13 +var bytes = require('bytes')
14 +var debug = require('debug')('body-parser:raw')
15 +var read = require('../read')
16 +var typeis = require('type-is')
17 +
18 +/**
19 + * Module exports.
20 + */
21 +
22 +module.exports = raw
23 +
24 +/**
25 + * Create a middleware to parse raw bodies.
26 + *
27 + * @param {object} [options]
28 + * @return {function}
29 + * @api public
30 + */
31 +
32 +function raw (options) {
33 + var opts = options || {}
34 +
35 + var inflate = opts.inflate !== false
36 + var limit = typeof opts.limit !== 'number'
37 + ? bytes.parse(opts.limit || '100kb')
38 + : opts.limit
39 + var type = opts.type || 'application/octet-stream'
40 + var verify = opts.verify || false
41 +
42 + if (verify !== false && typeof verify !== 'function') {
43 + throw new TypeError('option verify must be function')
44 + }
45 +
46 + // create the appropriate type checking function
47 + var shouldParse = typeof type !== 'function'
48 + ? typeChecker(type)
49 + : type
50 +
51 + function parse (buf) {
52 + return buf
53 + }
54 +
55 + return function rawParser (req, res, next) {
56 + if (req._body) {
57 + debug('body already parsed')
58 + next()
59 + return
60 + }
61 +
62 + req.body = req.body || {}
63 +
64 + // skip requests without bodies
65 + if (!typeis.hasBody(req)) {
66 + debug('skip empty body')
67 + next()
68 + return
69 + }
70 +
71 + debug('content-type %j', req.headers['content-type'])
72 +
73 + // determine if request should be parsed
74 + if (!shouldParse(req)) {
75 + debug('skip parsing')
76 + next()
77 + return
78 + }
79 +
80 + // read
81 + read(req, res, next, parse, debug, {
82 + encoding: null,
83 + inflate: inflate,
84 + limit: limit,
85 + verify: verify
86 + })
87 + }
88 +}
89 +
90 +/**
91 + * Get the simple type checker.
92 + *
93 + * @param {string} type
94 + * @return {function}
95 + */
96 +
97 +function typeChecker (type) {
98 + return function checkType (req) {
99 + return Boolean(typeis(req, type))
100 + }
101 +}
1 +/*!
2 + * body-parser
3 + * Copyright(c) 2014-2015 Douglas Christopher Wilson
4 + * MIT Licensed
5 + */
6 +
7 +'use strict'
8 +
9 +/**
10 + * Module dependencies.
11 + */
12 +
13 +var bytes = require('bytes')
14 +var contentType = require('content-type')
15 +var debug = require('debug')('body-parser:text')
16 +var read = require('../read')
17 +var typeis = require('type-is')
18 +
19 +/**
20 + * Module exports.
21 + */
22 +
23 +module.exports = text
24 +
25 +/**
26 + * Create a middleware to parse text bodies.
27 + *
28 + * @param {object} [options]
29 + * @return {function}
30 + * @api public
31 + */
32 +
33 +function text (options) {
34 + var opts = options || {}
35 +
36 + var defaultCharset = opts.defaultCharset || 'utf-8'
37 + var inflate = opts.inflate !== false
38 + var limit = typeof opts.limit !== 'number'
39 + ? bytes.parse(opts.limit || '100kb')
40 + : opts.limit
41 + var type = opts.type || 'text/plain'
42 + var verify = opts.verify || false
43 +
44 + if (verify !== false && typeof verify !== 'function') {
45 + throw new TypeError('option verify must be function')
46 + }
47 +
48 + // create the appropriate type checking function
49 + var shouldParse = typeof type !== 'function'
50 + ? typeChecker(type)
51 + : type
52 +
53 + function parse (buf) {
54 + return buf
55 + }
56 +
57 + return function textParser (req, res, next) {
58 + if (req._body) {
59 + debug('body already parsed')
60 + next()
61 + return
62 + }
63 +
64 + req.body = req.body || {}
65 +
66 + // skip requests without bodies
67 + if (!typeis.hasBody(req)) {
68 + debug('skip empty body')
69 + next()
70 + return
71 + }
72 +
73 + debug('content-type %j', req.headers['content-type'])
74 +
75 + // determine if request should be parsed
76 + if (!shouldParse(req)) {
77 + debug('skip parsing')
78 + next()
79 + return
80 + }
81 +
82 + // get charset
83 + var charset = getCharset(req) || defaultCharset
84 +
85 + // read
86 + read(req, res, next, parse, debug, {
87 + encoding: charset,
88 + inflate: inflate,
89 + limit: limit,
90 + verify: verify
91 + })
92 + }
93 +}
94 +
95 +/**
96 + * Get the charset of a request.
97 + *
98 + * @param {object} req
99 + * @api private
100 + */
101 +
102 +function getCharset (req) {
103 + try {
104 + return (contentType.parse(req).parameters.charset || '').toLowerCase()
105 + } catch (e) {
106 + return undefined
107 + }
108 +}
109 +
110 +/**
111 + * Get the simple type checker.
112 + *
113 + * @param {string} type
114 + * @return {function}
115 + */
116 +
117 +function typeChecker (type) {
118 + return function checkType (req) {
119 + return Boolean(typeis(req, type))
120 + }
121 +}
1 +/*!
2 + * body-parser
3 + * Copyright(c) 2014 Jonathan Ong
4 + * Copyright(c) 2014-2015 Douglas Christopher Wilson
5 + * MIT Licensed
6 + */
7 +
8 +'use strict'
9 +
10 +/**
11 + * Module dependencies.
12 + * @private
13 + */
14 +
15 +var bytes = require('bytes')
16 +var contentType = require('content-type')
17 +var createError = require('http-errors')
18 +var debug = require('debug')('body-parser:urlencoded')
19 +var deprecate = require('depd')('body-parser')
20 +var read = require('../read')
21 +var typeis = require('type-is')
22 +
23 +/**
24 + * Module exports.
25 + */
26 +
27 +module.exports = urlencoded
28 +
29 +/**
30 + * Cache of parser modules.
31 + */
32 +
33 +var parsers = Object.create(null)
34 +
35 +/**
36 + * Create a middleware to parse urlencoded bodies.
37 + *
38 + * @param {object} [options]
39 + * @return {function}
40 + * @public
41 + */
42 +
43 +function urlencoded (options) {
44 + var opts = options || {}
45 +
46 + // notice because option default will flip in next major
47 + if (opts.extended === undefined) {
48 + deprecate('undefined extended: provide extended option')
49 + }
50 +
51 + var extended = opts.extended !== false
52 + var inflate = opts.inflate !== false
53 + var limit = typeof opts.limit !== 'number'
54 + ? bytes.parse(opts.limit || '100kb')
55 + : opts.limit
56 + var type = opts.type || 'application/x-www-form-urlencoded'
57 + var verify = opts.verify || false
58 +
59 + if (verify !== false && typeof verify !== 'function') {
60 + throw new TypeError('option verify must be function')
61 + }
62 +
63 + // create the appropriate query parser
64 + var queryparse = extended
65 + ? extendedparser(opts)
66 + : simpleparser(opts)
67 +
68 + // create the appropriate type checking function
69 + var shouldParse = typeof type !== 'function'
70 + ? typeChecker(type)
71 + : type
72 +
73 + function parse (body) {
74 + return body.length
75 + ? queryparse(body)
76 + : {}
77 + }
78 +
79 + return function urlencodedParser (req, res, next) {
80 + if (req._body) {
81 + debug('body already parsed')
82 + next()
83 + return
84 + }
85 +
86 + req.body = req.body || {}
87 +
88 + // skip requests without bodies
89 + if (!typeis.hasBody(req)) {
90 + debug('skip empty body')
91 + next()
92 + return
93 + }
94 +
95 + debug('content-type %j', req.headers['content-type'])
96 +
97 + // determine if request should be parsed
98 + if (!shouldParse(req)) {
99 + debug('skip parsing')
100 + next()
101 + return
102 + }
103 +
104 + // assert charset
105 + var charset = getCharset(req) || 'utf-8'
106 + if (charset !== 'utf-8') {
107 + debug('invalid charset')
108 + next(createError(415, 'unsupported charset "' + charset.toUpperCase() + '"', {
109 + charset: charset,
110 + type: 'charset.unsupported'
111 + }))
112 + return
113 + }
114 +
115 + // read
116 + read(req, res, next, parse, debug, {
117 + debug: debug,
118 + encoding: charset,
119 + inflate: inflate,
120 + limit: limit,
121 + verify: verify
122 + })
123 + }
124 +}
125 +
126 +/**
127 + * Get the extended query parser.
128 + *
129 + * @param {object} options
130 + */
131 +
132 +function extendedparser (options) {
133 + var parameterLimit = options.parameterLimit !== undefined
134 + ? options.parameterLimit
135 + : 1000
136 + var parse = parser('qs')
137 +
138 + if (isNaN(parameterLimit) || parameterLimit < 1) {
139 + throw new TypeError('option parameterLimit must be a positive number')
140 + }
141 +
142 + if (isFinite(parameterLimit)) {
143 + parameterLimit = parameterLimit | 0
144 + }
145 +
146 + return function queryparse (body) {
147 + var paramCount = parameterCount(body, parameterLimit)
148 +
149 + if (paramCount === undefined) {
150 + debug('too many parameters')
151 + throw createError(413, 'too many parameters', {
152 + type: 'parameters.too.many'
153 + })
154 + }
155 +
156 + var arrayLimit = Math.max(100, paramCount)
157 +
158 + debug('parse extended urlencoding')
159 + return parse(body, {
160 + allowPrototypes: true,
161 + arrayLimit: arrayLimit,
162 + depth: Infinity,
163 + parameterLimit: parameterLimit
164 + })
165 + }
166 +}
167 +
168 +/**
169 + * Get the charset of a request.
170 + *
171 + * @param {object} req
172 + * @api private
173 + */
174 +
175 +function getCharset (req) {
176 + try {
177 + return (contentType.parse(req).parameters.charset || '').toLowerCase()
178 + } catch (e) {
179 + return undefined
180 + }
181 +}
182 +
183 +/**
184 + * Count the number of parameters, stopping once limit reached
185 + *
186 + * @param {string} body
187 + * @param {number} limit
188 + * @api private
189 + */
190 +
191 +function parameterCount (body, limit) {
192 + var count = 0
193 + var index = 0
194 +
195 + while ((index = body.indexOf('&', index)) !== -1) {
196 + count++
197 + index++
198 +
199 + if (count === limit) {
200 + return undefined
201 + }
202 + }
203 +
204 + return count
205 +}
206 +
207 +/**
208 + * Get parser for module name dynamically.
209 + *
210 + * @param {string} name
211 + * @return {function}
212 + * @api private
213 + */
214 +
215 +function parser (name) {
216 + var mod = parsers[name]
217 +
218 + if (mod !== undefined) {
219 + return mod.parse
220 + }
221 +
222 + // this uses a switch for static require analysis
223 + switch (name) {
224 + case 'qs':
225 + mod = require('qs')
226 + break
227 + case 'querystring':
228 + mod = require('querystring')
229 + break
230 + }
231 +
232 + // store to prevent invoking require()
233 + parsers[name] = mod
234 +
235 + return mod.parse
236 +}
237 +
238 +/**
239 + * Get the simple query parser.
240 + *
241 + * @param {object} options
242 + */
243 +
244 +function simpleparser (options) {
245 + var parameterLimit = options.parameterLimit !== undefined
246 + ? options.parameterLimit
247 + : 1000
248 + var parse = parser('querystring')
249 +
250 + if (isNaN(parameterLimit) || parameterLimit < 1) {
251 + throw new TypeError('option parameterLimit must be a positive number')
252 + }
253 +
254 + if (isFinite(parameterLimit)) {
255 + parameterLimit = parameterLimit | 0
256 + }
257 +
258 + return function queryparse (body) {
259 + var paramCount = parameterCount(body, parameterLimit)
260 +
261 + if (paramCount === undefined) {
262 + debug('too many parameters')
263 + throw createError(413, 'too many parameters', {
264 + type: 'parameters.too.many'
265 + })
266 + }
267 +
268 + debug('parse urlencoding')
269 + return parse(body, undefined, undefined, {maxKeys: parameterLimit})
270 + }
271 +}
272 +
273 +/**
274 + * Get the simple type checker.
275 + *
276 + * @param {string} type
277 + * @return {function}
278 + */
279 +
280 +function typeChecker (type) {
281 + return function checkType (req) {
282 + return Boolean(typeis(req, type))
283 + }
284 +}
1 +{
2 + "name": "body-parser",
3 + "description": "Node.js body parsing middleware",
4 + "version": "1.18.3",
5 + "contributors": [
6 + "Douglas Christopher Wilson <doug@somethingdoug.com>",
7 + "Jonathan Ong <me@jongleberry.com> (http://jongleberry.com)"
8 + ],
9 + "license": "MIT",
10 + "repository": "expressjs/body-parser",
11 + "dependencies": {
12 + "bytes": "3.0.0",
13 + "content-type": "~1.0.4",
14 + "debug": "2.6.9",
15 + "depd": "~1.1.2",
16 + "http-errors": "~1.6.3",
17 + "iconv-lite": "0.4.23",
18 + "on-finished": "~2.3.0",
19 + "qs": "6.5.2",
20 + "raw-body": "2.3.3",
21 + "type-is": "~1.6.16"
22 + },
23 + "devDependencies": {
24 + "eslint": "4.19.1",
25 + "eslint-config-standard": "11.0.0",
26 + "eslint-plugin-import": "2.11.0",
27 + "eslint-plugin-markdown": "1.0.0-beta.6",
28 + "eslint-plugin-node": "6.0.1",
29 + "eslint-plugin-promise": "3.7.0",
30 + "eslint-plugin-standard": "3.1.0",
31 + "istanbul": "0.4.5",
32 + "methods": "1.1.2",
33 + "mocha": "2.5.3",
34 + "safe-buffer": "5.1.2",
35 + "supertest": "1.1.0"
36 + },
37 + "files": [
38 + "lib/",
39 + "LICENSE",
40 + "HISTORY.md",
41 + "index.js"
42 + ],
43 + "engines": {
44 + "node": ">= 0.8"
45 + },
46 + "scripts": {
47 + "lint": "eslint --plugin markdown --ext js,md .",
48 + "test": "mocha --require test/support/env --reporter spec --check-leaks --bail test/",
49 + "test-cov": "istanbul cover node_modules/mocha/bin/_mocha -- --require test/support/env --reporter dot --check-leaks test/",
50 + "test-travis": "istanbul cover node_modules/mocha/bin/_mocha --report lcovonly -- --require test/support/env --reporter spec --check-leaks test/"
51 + }
52 +}
1 +3.0.0 / 2017-08-31
2 +==================
3 +
4 + * Change "kB" to "KB" in format output
5 + * Remove support for Node.js 0.6
6 + * Remove support for ComponentJS
7 +
8 +2.5.0 / 2017-03-24
9 +==================
10 +
11 + * Add option "unit"
12 +
13 +2.4.0 / 2016-06-01
14 +==================
15 +
16 + * Add option "unitSeparator"
17 +
18 +2.3.0 / 2016-02-15
19 +==================
20 +
21 + * Drop partial bytes on all parsed units
22 + * Fix non-finite numbers to `.format` to return `null`
23 + * Fix parsing byte string that looks like hex
24 + * perf: hoist regular expressions
25 +
26 +2.2.0 / 2015-11-13
27 +==================
28 +
29 + * add option "decimalPlaces"
30 + * add option "fixedDecimals"
31 +
32 +2.1.0 / 2015-05-21
33 +==================
34 +
35 + * add `.format` export
36 + * add `.parse` export
37 +
38 +2.0.2 / 2015-05-20
39 +==================
40 +
41 + * remove map recreation
42 + * remove unnecessary object construction
43 +
44 +2.0.1 / 2015-05-07
45 +==================
46 +
47 + * fix browserify require
48 + * remove node.extend dependency
49 +
50 +2.0.0 / 2015-04-12
51 +==================
52 +
53 + * add option "case"
54 + * add option "thousandsSeparator"
55 + * return "null" on invalid parse input
56 + * support proper round-trip: bytes(bytes(num)) === num
57 + * units no longer case sensitive when parsing
58 +
59 +1.0.0 / 2014-05-05
60 +==================
61 +
62 + * add negative support. fixes #6
63 +
64 +0.3.0 / 2014-03-19
65 +==================
66 +
67 + * added terabyte support
68 +
69 +0.2.1 / 2013-04-01
70 +==================
71 +
72 + * add .component
73 +
74 +0.2.0 / 2012-10-28
75 +==================
76 +
77 + * bytes(200).should.eql('200b')
78 +
79 +0.1.0 / 2012-07-04
80 +==================
81 +
82 + * add bytes to string conversion [yields]
1 +(The MIT License)
2 +
3 +Copyright (c) 2012-2014 TJ Holowaychuk <tj@vision-media.ca>
4 +Copyright (c) 2015 Jed Watson <jed.watson@me.com>
5 +
6 +Permission is hereby granted, free of charge, to any person obtaining
7 +a copy of this software and associated documentation files (the
8 +'Software'), to deal in the Software without restriction, including
9 +without limitation the rights to use, copy, modify, merge, publish,
10 +distribute, sublicense, and/or sell copies of the Software, and to
11 +permit persons to whom the Software is furnished to do so, subject to
12 +the following conditions:
13 +
14 +The above copyright notice and this permission notice shall be
15 +included in all copies or substantial portions of the Software.
16 +
17 +THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
18 +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19 +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
20 +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
21 +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
22 +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
23 +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
1 +# Bytes utility
2 +
3 +[![NPM Version][npm-image]][npm-url]
4 +[![NPM Downloads][downloads-image]][downloads-url]
5 +[![Build Status][travis-image]][travis-url]
6 +[![Test Coverage][coveralls-image]][coveralls-url]
7 +
8 +Utility to parse a string bytes (ex: `1TB`) to bytes (`1099511627776`) and vice-versa.
9 +
10 +## Installation
11 +
12 +This is a [Node.js](https://nodejs.org/en/) module available through the
13 +[npm registry](https://www.npmjs.com/). Installation is done using the
14 +[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
15 +
16 +```bash
17 +$ npm install bytes
18 +```
19 +
20 +## Usage
21 +
22 +```js
23 +var bytes = require('bytes');
24 +```
25 +
26 +#### bytes.format(number value, [options]): string|null
27 +
28 +Format the given value in bytes into a string. If the value is negative, it is kept as such. If it is a float, it is
29 + rounded.
30 +
31 +**Arguments**
32 +
33 +| Name | Type | Description |
34 +|---------|----------|--------------------|
35 +| value | `number` | Value in bytes |
36 +| options | `Object` | Conversion options |
37 +
38 +**Options**
39 +
40 +| Property | Type | Description |
41 +|-------------------|--------|-----------------------------------------------------------------------------------------|
42 +| decimalPlaces | `number``null` | Maximum number of decimal places to include in output. Default value to `2`. |
43 +| fixedDecimals | `boolean``null` | Whether to always display the maximum number of decimal places. Default value to `false` |
44 +| thousandsSeparator | `string``null` | Example of values: `' '`, `','` and `.`... Default value to `''`. |
45 +| unit | `string``null` | The unit in which the result will be returned (B/KB/MB/GB/TB). Default value to `''` (which means auto detect). |
46 +| unitSeparator | `string``null` | Separator to use between number and unit. Default value to `''`. |
47 +
48 +**Returns**
49 +
50 +| Name | Type | Description |
51 +|---------|------------------|-------------------------------------------------|
52 +| results | `string``null` | Return null upon error. String value otherwise. |
53 +
54 +**Example**
55 +
56 +```js
57 +bytes(1024);
58 +// output: '1KB'
59 +
60 +bytes(1000);
61 +// output: '1000B'
62 +
63 +bytes(1000, {thousandsSeparator: ' '});
64 +// output: '1 000B'
65 +
66 +bytes(1024 * 1.7, {decimalPlaces: 0});
67 +// output: '2KB'
68 +
69 +bytes(1024, {unitSeparator: ' '});
70 +// output: '1 KB'
71 +
72 +```
73 +
74 +#### bytes.parse(string|number value): number|null
75 +
76 +Parse the string value into an integer in bytes. If no unit is given, or `value`
77 +is a number, it is assumed the value is in bytes.
78 +
79 +Supported units and abbreviations are as follows and are case-insensitive:
80 +
81 + * `b` for bytes
82 + * `kb` for kilobytes
83 + * `mb` for megabytes
84 + * `gb` for gigabytes
85 + * `tb` for terabytes
86 +
87 +The units are in powers of two, not ten. This means 1kb = 1024b according to this parser.
88 +
89 +**Arguments**
90 +
91 +| Name | Type | Description |
92 +|---------------|--------|--------------------|
93 +| value | `string``number` | String to parse, or number in bytes. |
94 +
95 +**Returns**
96 +
97 +| Name | Type | Description |
98 +|---------|-------------|-------------------------|
99 +| results | `number``null` | Return null upon error. Value in bytes otherwise. |
100 +
101 +**Example**
102 +
103 +```js
104 +bytes('1KB');
105 +// output: 1024
106 +
107 +bytes('1024');
108 +// output: 1024
109 +
110 +bytes(1024);
111 +// output: 1024
112 +```
113 +
114 +## License
115 +
116 +[MIT](LICENSE)
117 +
118 +[downloads-image]: https://img.shields.io/npm/dm/bytes.svg
119 +[downloads-url]: https://npmjs.org/package/bytes
120 +[npm-image]: https://img.shields.io/npm/v/bytes.svg
121 +[npm-url]: https://npmjs.org/package/bytes
122 +[travis-image]: https://img.shields.io/travis/visionmedia/bytes.js/master.svg
123 +[travis-url]: https://travis-ci.org/visionmedia/bytes.js
124 +[coveralls-image]: https://img.shields.io/coveralls/visionmedia/bytes.js/master.svg
125 +[coveralls-url]: https://coveralls.io/r/visionmedia/bytes.js?branch=master
1 +/*!
2 + * bytes
3 + * Copyright(c) 2012-2014 TJ Holowaychuk
4 + * Copyright(c) 2015 Jed Watson
5 + * MIT Licensed
6 + */
7 +
8 +'use strict';
9 +
10 +/**
11 + * Module exports.
12 + * @public
13 + */
14 +
15 +module.exports = bytes;
16 +module.exports.format = format;
17 +module.exports.parse = parse;
18 +
19 +/**
20 + * Module variables.
21 + * @private
22 + */
23 +
24 +var formatThousandsRegExp = /\B(?=(\d{3})+(?!\d))/g;
25 +
26 +var formatDecimalsRegExp = /(?:\.0*|(\.[^0]+)0+)$/;
27 +
28 +var map = {
29 + b: 1,
30 + kb: 1 << 10,
31 + mb: 1 << 20,
32 + gb: 1 << 30,
33 + tb: ((1 << 30) * 1024)
34 +};
35 +
36 +var parseRegExp = /^((-|\+)?(\d+(?:\.\d+)?)) *(kb|mb|gb|tb)$/i;
37 +
38 +/**
39 + * Convert the given value in bytes into a string or parse to string to an integer in bytes.
40 + *
41 + * @param {string|number} value
42 + * @param {{
43 + * case: [string],
44 + * decimalPlaces: [number]
45 + * fixedDecimals: [boolean]
46 + * thousandsSeparator: [string]
47 + * unitSeparator: [string]
48 + * }} [options] bytes options.
49 + *
50 + * @returns {string|number|null}
51 + */
52 +
53 +function bytes(value, options) {
54 + if (typeof value === 'string') {
55 + return parse(value);
56 + }
57 +
58 + if (typeof value === 'number') {
59 + return format(value, options);
60 + }
61 +
62 + return null;
63 +}
64 +
65 +/**
66 + * Format the given value in bytes into a string.
67 + *
68 + * If the value is negative, it is kept as such. If it is a float,
69 + * it is rounded.
70 + *
71 + * @param {number} value
72 + * @param {object} [options]
73 + * @param {number} [options.decimalPlaces=2]
74 + * @param {number} [options.fixedDecimals=false]
75 + * @param {string} [options.thousandsSeparator=]
76 + * @param {string} [options.unit=]
77 + * @param {string} [options.unitSeparator=]
78 + *
79 + * @returns {string|null}
80 + * @public
81 + */
82 +
83 +function format(value, options) {
84 + if (!Number.isFinite(value)) {
85 + return null;
86 + }
87 +
88 + var mag = Math.abs(value);
89 + var thousandsSeparator = (options && options.thousandsSeparator) || '';
90 + var unitSeparator = (options && options.unitSeparator) || '';
91 + var decimalPlaces = (options && options.decimalPlaces !== undefined) ? options.decimalPlaces : 2;
92 + var fixedDecimals = Boolean(options && options.fixedDecimals);
93 + var unit = (options && options.unit) || '';
94 +
95 + if (!unit || !map[unit.toLowerCase()]) {
96 + if (mag >= map.tb) {
97 + unit = 'TB';
98 + } else if (mag >= map.gb) {
99 + unit = 'GB';
100 + } else if (mag >= map.mb) {
101 + unit = 'MB';
102 + } else if (mag >= map.kb) {
103 + unit = 'KB';
104 + } else {
105 + unit = 'B';
106 + }
107 + }
108 +
109 + var val = value / map[unit.toLowerCase()];
110 + var str = val.toFixed(decimalPlaces);
111 +
112 + if (!fixedDecimals) {
113 + str = str.replace(formatDecimalsRegExp, '$1');
114 + }
115 +
116 + if (thousandsSeparator) {
117 + str = str.replace(formatThousandsRegExp, thousandsSeparator);
118 + }
119 +
120 + return str + unitSeparator + unit;
121 +}
122 +
123 +/**
124 + * Parse the string value into an integer in bytes.
125 + *
126 + * If no unit is given, it is assumed the value is in bytes.
127 + *
128 + * @param {number|string} val
129 + *
130 + * @returns {number|null}
131 + * @public
132 + */
133 +
134 +function parse(val) {
135 + if (typeof val === 'number' && !isNaN(val)) {
136 + return val;
137 + }
138 +
139 + if (typeof val !== 'string') {
140 + return null;
141 + }
142 +
143 + // Test if the string passed is valid
144 + var results = parseRegExp.exec(val);
145 + var floatValue;
146 + var unit = 'b';
147 +
148 + if (!results) {
149 + // Nothing could be extracted from the given string
150 + floatValue = parseInt(val, 10);
151 + unit = 'b'
152 + } else {
153 + // Retrieve the value and the unit
154 + floatValue = parseFloat(results[1]);
155 + unit = results[4].toLowerCase();
156 + }
157 +
158 + return Math.floor(map[unit] * floatValue);
159 +}
1 +{
2 + "name": "bytes",
3 + "description": "Utility to parse a string bytes to bytes and vice-versa",
4 + "version": "3.0.0",
5 + "author": "TJ Holowaychuk <tj@vision-media.ca> (http://tjholowaychuk.com)",
6 + "contributors": [
7 + "Jed Watson <jed.watson@me.com>",
8 + "Théo FIDRY <theo.fidry@gmail.com>"
9 + ],
10 + "license": "MIT",
11 + "keywords": [
12 + "byte",
13 + "bytes",
14 + "utility",
15 + "parse",
16 + "parser",
17 + "convert",
18 + "converter"
19 + ],
20 + "repository": "visionmedia/bytes.js",
21 + "devDependencies": {
22 + "mocha": "2.5.3",
23 + "nyc": "10.3.2"
24 + },
25 + "files": [
26 + "History.md",
27 + "LICENSE",
28 + "Readme.md",
29 + "index.js"
30 + ],
31 + "engines": {
32 + "node": ">= 0.8"
33 + },
34 + "scripts": {
35 + "test": "mocha --check-leaks --reporter spec",
36 + "test-ci": "nyc --reporter=text npm test",
37 + "test-cov": "nyc --reporter=html --reporter=text npm test"
38 + }
39 +}
1 +0.5.2 / 2016-12-08
2 +==================
3 +
4 + * Fix `parse` to accept any linear whitespace character
5 +
6 +0.5.1 / 2016-01-17
7 +==================
8 +
9 + * perf: enable strict mode
10 +
11 +0.5.0 / 2014-10-11
12 +==================
13 +
14 + * Add `parse` function
15 +
16 +0.4.0 / 2014-09-21
17 +==================
18 +
19 + * Expand non-Unicode `filename` to the full ISO-8859-1 charset
20 +
21 +0.3.0 / 2014-09-20
22 +==================
23 +
24 + * Add `fallback` option
25 + * Add `type` option
26 +
27 +0.2.0 / 2014-09-19
28 +==================
29 +
30 + * Reduce ambiguity of file names with hex escape in buggy browsers
31 +
32 +0.1.2 / 2014-09-19
33 +==================
34 +
35 + * Fix periodic invalid Unicode filename header
36 +
37 +0.1.1 / 2014-09-19
38 +==================
39 +
40 + * Fix invalid characters appearing in `filename*` parameter
41 +
42 +0.1.0 / 2014-09-18
43 +==================
44 +
45 + * Make the `filename` argument optional
46 +
47 +0.0.0 / 2014-09-18
48 +==================
49 +
50 + * Initial release
1 +(The MIT License)
2 +
3 +Copyright (c) 2014 Douglas Christopher Wilson
4 +
5 +Permission is hereby granted, free of charge, to any person obtaining
6 +a copy of this software and associated documentation files (the
7 +'Software'), to deal in the Software without restriction, including
8 +without limitation the rights to use, copy, modify, merge, publish,
9 +distribute, sublicense, and/or sell copies of the Software, and to
10 +permit persons to whom the Software is furnished to do so, subject to
11 +the following conditions:
12 +
13 +The above copyright notice and this permission notice shall be
14 +included in all copies or substantial portions of the Software.
15 +
16 +THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
17 +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19 +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
20 +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
21 +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
22 +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
1 +# content-disposition
2 +
3 +[![NPM Version][npm-image]][npm-url]
4 +[![NPM Downloads][downloads-image]][downloads-url]
5 +[![Node.js Version][node-version-image]][node-version-url]
6 +[![Build Status][travis-image]][travis-url]
7 +[![Test Coverage][coveralls-image]][coveralls-url]
8 +
9 +Create and parse HTTP `Content-Disposition` header
10 +
11 +## Installation
12 +
13 +```sh
14 +$ npm install content-disposition
15 +```
16 +
17 +## API
18 +
19 +```js
20 +var contentDisposition = require('content-disposition')
21 +```
22 +
23 +### contentDisposition(filename, options)
24 +
25 +Create an attachment `Content-Disposition` header value using the given file name,
26 +if supplied. The `filename` is optional and if no file name is desired, but you
27 +want to specify `options`, set `filename` to `undefined`.
28 +
29 +```js
30 +res.setHeader('Content-Disposition', contentDisposition('∫ maths.pdf'))
31 +```
32 +
33 +**note** HTTP headers are of the ISO-8859-1 character set. If you are writing this
34 +header through a means different from `setHeader` in Node.js, you'll want to specify
35 +the `'binary'` encoding in Node.js.
36 +
37 +#### Options
38 +
39 +`contentDisposition` accepts these properties in the options object.
40 +
41 +##### fallback
42 +
43 +If the `filename` option is outside ISO-8859-1, then the file name is actually
44 +stored in a supplemental field for clients that support Unicode file names and
45 +a ISO-8859-1 version of the file name is automatically generated.
46 +
47 +This specifies the ISO-8859-1 file name to override the automatic generation or
48 +disables the generation all together, defaults to `true`.
49 +
50 + - A string will specify the ISO-8859-1 file name to use in place of automatic
51 + generation.
52 + - `false` will disable including a ISO-8859-1 file name and only include the
53 + Unicode version (unless the file name is already ISO-8859-1).
54 + - `true` will enable automatic generation if the file name is outside ISO-8859-1.
55 +
56 +If the `filename` option is ISO-8859-1 and this option is specified and has a
57 +different value, then the `filename` option is encoded in the extended field
58 +and this set as the fallback field, even though they are both ISO-8859-1.
59 +
60 +##### type
61 +
62 +Specifies the disposition type, defaults to `"attachment"`. This can also be
63 +`"inline"`, or any other value (all values except inline are treated like
64 +`attachment`, but can convey additional information if both parties agree to
65 +it). The type is normalized to lower-case.
66 +
67 +### contentDisposition.parse(string)
68 +
69 +```js
70 +var disposition = contentDisposition.parse('attachment; filename="EURO rates.txt"; filename*=UTF-8\'\'%e2%82%ac%20rates.txt');
71 +```
72 +
73 +Parse a `Content-Disposition` header string. This automatically handles extended
74 +("Unicode") parameters by decoding them and providing them under the standard
75 +parameter name. This will return an object with the following properties (examples
76 +are shown for the string `'attachment; filename="EURO rates.txt"; filename*=UTF-8\'\'%e2%82%ac%20rates.txt'`):
77 +
78 + - `type`: The disposition type (always lower case). Example: `'attachment'`
79 +
80 + - `parameters`: An object of the parameters in the disposition (name of parameter
81 + always lower case and extended versions replace non-extended versions). Example:
82 + `{filename: "€ rates.txt"}`
83 +
84 +## Examples
85 +
86 +### Send a file for download
87 +
88 +```js
89 +var contentDisposition = require('content-disposition')
90 +var destroy = require('destroy')
91 +var http = require('http')
92 +var onFinished = require('on-finished')
93 +
94 +var filePath = '/path/to/public/plans.pdf'
95 +
96 +http.createServer(function onRequest(req, res) {
97 + // set headers
98 + res.setHeader('Content-Type', 'application/pdf')
99 + res.setHeader('Content-Disposition', contentDisposition(filePath))
100 +
101 + // send file
102 + var stream = fs.createReadStream(filePath)
103 + stream.pipe(res)
104 + onFinished(res, function (err) {
105 + destroy(stream)
106 + })
107 +})
108 +```
109 +
110 +## Testing
111 +
112 +```sh
113 +$ npm test
114 +```
115 +
116 +## References
117 +
118 +- [RFC 2616: Hypertext Transfer Protocol -- HTTP/1.1][rfc-2616]
119 +- [RFC 5987: Character Set and Language Encoding for Hypertext Transfer Protocol (HTTP) Header Field Parameters][rfc-5987]
120 +- [RFC 6266: Use of the Content-Disposition Header Field in the Hypertext Transfer Protocol (HTTP)][rfc-6266]
121 +- [Test Cases for HTTP Content-Disposition header field (RFC 6266) and the Encodings defined in RFCs 2047, 2231 and 5987][tc-2231]
122 +
123 +[rfc-2616]: https://tools.ietf.org/html/rfc2616
124 +[rfc-5987]: https://tools.ietf.org/html/rfc5987
125 +[rfc-6266]: https://tools.ietf.org/html/rfc6266
126 +[tc-2231]: http://greenbytes.de/tech/tc2231/
127 +
128 +## License
129 +
130 +[MIT](LICENSE)
131 +
132 +[npm-image]: https://img.shields.io/npm/v/content-disposition.svg?style=flat
133 +[npm-url]: https://npmjs.org/package/content-disposition
134 +[node-version-image]: https://img.shields.io/node/v/content-disposition.svg?style=flat
135 +[node-version-url]: https://nodejs.org/en/download
136 +[travis-image]: https://img.shields.io/travis/jshttp/content-disposition.svg?style=flat
137 +[travis-url]: https://travis-ci.org/jshttp/content-disposition
138 +[coveralls-image]: https://img.shields.io/coveralls/jshttp/content-disposition.svg?style=flat
139 +[coveralls-url]: https://coveralls.io/r/jshttp/content-disposition?branch=master
140 +[downloads-image]: https://img.shields.io/npm/dm/content-disposition.svg?style=flat
141 +[downloads-url]: https://npmjs.org/package/content-disposition
This diff is collapsed. Click to expand it.
1 +{
2 + "name": "content-disposition",
3 + "description": "Create and parse Content-Disposition header",
4 + "version": "0.5.2",
5 + "contributors": [
6 + "Douglas Christopher Wilson <doug@somethingdoug.com>"
7 + ],
8 + "license": "MIT",
9 + "keywords": [
10 + "content-disposition",
11 + "http",
12 + "rfc6266",
13 + "res"
14 + ],
15 + "repository": "jshttp/content-disposition",
16 + "devDependencies": {
17 + "eslint": "3.11.1",
18 + "eslint-config-standard": "6.2.1",
19 + "eslint-plugin-promise": "3.3.0",
20 + "eslint-plugin-standard": "2.0.1",
21 + "istanbul": "0.4.5",
22 + "mocha": "1.21.5"
23 + },
24 + "files": [
25 + "LICENSE",
26 + "HISTORY.md",
27 + "README.md",
28 + "index.js"
29 + ],
30 + "engines": {
31 + "node": ">= 0.6"
32 + },
33 + "scripts": {
34 + "lint": "eslint .",
35 + "test": "mocha --reporter spec --bail --check-leaks test/",
36 + "test-cov": "istanbul cover node_modules/mocha/bin/_mocha -- --reporter dot --check-leaks test/",
37 + "test-travis": "istanbul cover node_modules/mocha/bin/_mocha --report lcovonly -- --reporter spec --check-leaks test/"
38 + }
39 +}
1 +1.0.4 / 2017-09-11
2 +==================
3 +
4 + * perf: skip parameter parsing when no parameters
5 +
6 +1.0.3 / 2017-09-10
7 +==================
8 +
9 + * perf: remove argument reassignment
10 +
11 +1.0.2 / 2016-05-09
12 +==================
13 +
14 + * perf: enable strict mode
15 +
16 +1.0.1 / 2015-02-13
17 +==================
18 +
19 + * Improve missing `Content-Type` header error message
20 +
21 +1.0.0 / 2015-02-01
22 +==================
23 +
24 + * Initial implementation, derived from `media-typer@0.3.0`
1 +(The MIT License)
2 +
3 +Copyright (c) 2015 Douglas Christopher Wilson
4 +
5 +Permission is hereby granted, free of charge, to any person obtaining
6 +a copy of this software and associated documentation files (the
7 +'Software'), to deal in the Software without restriction, including
8 +without limitation the rights to use, copy, modify, merge, publish,
9 +distribute, sublicense, and/or sell copies of the Software, and to
10 +permit persons to whom the Software is furnished to do so, subject to
11 +the following conditions:
12 +
13 +The above copyright notice and this permission notice shall be
14 +included in all copies or substantial portions of the Software.
15 +
16 +THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
17 +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19 +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
20 +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
21 +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
22 +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
1 +# content-type
2 +
3 +[![NPM Version][npm-image]][npm-url]
4 +[![NPM Downloads][downloads-image]][downloads-url]
5 +[![Node.js Version][node-version-image]][node-version-url]
6 +[![Build Status][travis-image]][travis-url]
7 +[![Test Coverage][coveralls-image]][coveralls-url]
8 +
9 +Create and parse HTTP Content-Type header according to RFC 7231
10 +
11 +## Installation
12 +
13 +```sh
14 +$ npm install content-type
15 +```
16 +
17 +## API
18 +
19 +```js
20 +var contentType = require('content-type')
21 +```
22 +
23 +### contentType.parse(string)
24 +
25 +```js
26 +var obj = contentType.parse('image/svg+xml; charset=utf-8')
27 +```
28 +
29 +Parse a content type string. This will return an object with the following
30 +properties (examples are shown for the string `'image/svg+xml; charset=utf-8'`):
31 +
32 + - `type`: The media type (the type and subtype, always lower case).
33 + Example: `'image/svg+xml'`
34 +
35 + - `parameters`: An object of the parameters in the media type (name of parameter
36 + always lower case). Example: `{charset: 'utf-8'}`
37 +
38 +Throws a `TypeError` if the string is missing or invalid.
39 +
40 +### contentType.parse(req)
41 +
42 +```js
43 +var obj = contentType.parse(req)
44 +```
45 +
46 +Parse the `content-type` header from the given `req`. Short-cut for
47 +`contentType.parse(req.headers['content-type'])`.
48 +
49 +Throws a `TypeError` if the `Content-Type` header is missing or invalid.
50 +
51 +### contentType.parse(res)
52 +
53 +```js
54 +var obj = contentType.parse(res)
55 +```
56 +
57 +Parse the `content-type` header set on the given `res`. Short-cut for
58 +`contentType.parse(res.getHeader('content-type'))`.
59 +
60 +Throws a `TypeError` if the `Content-Type` header is missing or invalid.
61 +
62 +### contentType.format(obj)
63 +
64 +```js
65 +var str = contentType.format({type: 'image/svg+xml'})
66 +```
67 +
68 +Format an object into a content type string. This will return a string of the
69 +content type for the given object with the following properties (examples are
70 +shown that produce the string `'image/svg+xml; charset=utf-8'`):
71 +
72 + - `type`: The media type (will be lower-cased). Example: `'image/svg+xml'`
73 +
74 + - `parameters`: An object of the parameters in the media type (name of the
75 + parameter will be lower-cased). Example: `{charset: 'utf-8'}`
76 +
77 +Throws a `TypeError` if the object contains an invalid type or parameter names.
78 +
79 +## License
80 +
81 +[MIT](LICENSE)
82 +
83 +[npm-image]: https://img.shields.io/npm/v/content-type.svg
84 +[npm-url]: https://npmjs.org/package/content-type
85 +[node-version-image]: https://img.shields.io/node/v/content-type.svg
86 +[node-version-url]: http://nodejs.org/download/
87 +[travis-image]: https://img.shields.io/travis/jshttp/content-type/master.svg
88 +[travis-url]: https://travis-ci.org/jshttp/content-type
89 +[coveralls-image]: https://img.shields.io/coveralls/jshttp/content-type/master.svg
90 +[coveralls-url]: https://coveralls.io/r/jshttp/content-type
91 +[downloads-image]: https://img.shields.io/npm/dm/content-type.svg
92 +[downloads-url]: https://npmjs.org/package/content-type
1 +/*!
2 + * content-type
3 + * Copyright(c) 2015 Douglas Christopher Wilson
4 + * MIT Licensed
5 + */
6 +
7 +'use strict'
8 +
9 +/**
10 + * RegExp to match *( ";" parameter ) in RFC 7231 sec 3.1.1.1
11 + *
12 + * parameter = token "=" ( token / quoted-string )
13 + * token = 1*tchar
14 + * tchar = "!" / "#" / "$" / "%" / "&" / "'" / "*"
15 + * / "+" / "-" / "." / "^" / "_" / "`" / "|" / "~"
16 + * / DIGIT / ALPHA
17 + * ; any VCHAR, except delimiters
18 + * quoted-string = DQUOTE *( qdtext / quoted-pair ) DQUOTE
19 + * qdtext = HTAB / SP / %x21 / %x23-5B / %x5D-7E / obs-text
20 + * obs-text = %x80-FF
21 + * quoted-pair = "\" ( HTAB / SP / VCHAR / obs-text )
22 + */
23 +var PARAM_REGEXP = /; *([!#$%&'*+.^_`|~0-9A-Za-z-]+) *= *("(?:[\u000b\u0020\u0021\u0023-\u005b\u005d-\u007e\u0080-\u00ff]|\\[\u000b\u0020-\u00ff])*"|[!#$%&'*+.^_`|~0-9A-Za-z-]+) */g
24 +var TEXT_REGEXP = /^[\u000b\u0020-\u007e\u0080-\u00ff]+$/
25 +var TOKEN_REGEXP = /^[!#$%&'*+.^_`|~0-9A-Za-z-]+$/
26 +
27 +/**
28 + * RegExp to match quoted-pair in RFC 7230 sec 3.2.6
29 + *
30 + * quoted-pair = "\" ( HTAB / SP / VCHAR / obs-text )
31 + * obs-text = %x80-FF
32 + */
33 +var QESC_REGEXP = /\\([\u000b\u0020-\u00ff])/g
34 +
35 +/**
36 + * RegExp to match chars that must be quoted-pair in RFC 7230 sec 3.2.6
37 + */
38 +var QUOTE_REGEXP = /([\\"])/g
39 +
40 +/**
41 + * RegExp to match type in RFC 7231 sec 3.1.1.1
42 + *
43 + * media-type = type "/" subtype
44 + * type = token
45 + * subtype = token
46 + */
47 +var TYPE_REGEXP = /^[!#$%&'*+.^_`|~0-9A-Za-z-]+\/[!#$%&'*+.^_`|~0-9A-Za-z-]+$/
48 +
49 +/**
50 + * Module exports.
51 + * @public
52 + */
53 +
54 +exports.format = format
55 +exports.parse = parse
56 +
57 +/**
58 + * Format object to media type.
59 + *
60 + * @param {object} obj
61 + * @return {string}
62 + * @public
63 + */
64 +
65 +function format (obj) {
66 + if (!obj || typeof obj !== 'object') {
67 + throw new TypeError('argument obj is required')
68 + }
69 +
70 + var parameters = obj.parameters
71 + var type = obj.type
72 +
73 + if (!type || !TYPE_REGEXP.test(type)) {
74 + throw new TypeError('invalid type')
75 + }
76 +
77 + var string = type
78 +
79 + // append parameters
80 + if (parameters && typeof parameters === 'object') {
81 + var param
82 + var params = Object.keys(parameters).sort()
83 +
84 + for (var i = 0; i < params.length; i++) {
85 + param = params[i]
86 +
87 + if (!TOKEN_REGEXP.test(param)) {
88 + throw new TypeError('invalid parameter name')
89 + }
90 +
91 + string += '; ' + param + '=' + qstring(parameters[param])
92 + }
93 + }
94 +
95 + return string
96 +}
97 +
98 +/**
99 + * Parse media type to object.
100 + *
101 + * @param {string|object} string
102 + * @return {Object}
103 + * @public
104 + */
105 +
106 +function parse (string) {
107 + if (!string) {
108 + throw new TypeError('argument string is required')
109 + }
110 +
111 + // support req/res-like objects as argument
112 + var header = typeof string === 'object'
113 + ? getcontenttype(string)
114 + : string
115 +
116 + if (typeof header !== 'string') {
117 + throw new TypeError('argument string is required to be a string')
118 + }
119 +
120 + var index = header.indexOf(';')
121 + var type = index !== -1
122 + ? header.substr(0, index).trim()
123 + : header.trim()
124 +
125 + if (!TYPE_REGEXP.test(type)) {
126 + throw new TypeError('invalid media type')
127 + }
128 +
129 + var obj = new ContentType(type.toLowerCase())
130 +
131 + // parse parameters
132 + if (index !== -1) {
133 + var key
134 + var match
135 + var value
136 +
137 + PARAM_REGEXP.lastIndex = index
138 +
139 + while ((match = PARAM_REGEXP.exec(header))) {
140 + if (match.index !== index) {
141 + throw new TypeError('invalid parameter format')
142 + }
143 +
144 + index += match[0].length
145 + key = match[1].toLowerCase()
146 + value = match[2]
147 +
148 + if (value[0] === '"') {
149 + // remove quotes and escapes
150 + value = value
151 + .substr(1, value.length - 2)
152 + .replace(QESC_REGEXP, '$1')
153 + }
154 +
155 + obj.parameters[key] = value
156 + }
157 +
158 + if (index !== header.length) {
159 + throw new TypeError('invalid parameter format')
160 + }
161 + }
162 +
163 + return obj
164 +}
165 +
166 +/**
167 + * Get content-type from req/res objects.
168 + *
169 + * @param {object}
170 + * @return {Object}
171 + * @private
172 + */
173 +
174 +function getcontenttype (obj) {
175 + var header
176 +
177 + if (typeof obj.getHeader === 'function') {
178 + // res-like
179 + header = obj.getHeader('content-type')
180 + } else if (typeof obj.headers === 'object') {
181 + // req-like
182 + header = obj.headers && obj.headers['content-type']
183 + }
184 +
185 + if (typeof header !== 'string') {
186 + throw new TypeError('content-type header is missing from object')
187 + }
188 +
189 + return header
190 +}
191 +
192 +/**
193 + * Quote a string if necessary.
194 + *
195 + * @param {string} val
196 + * @return {string}
197 + * @private
198 + */
199 +
200 +function qstring (val) {
201 + var str = String(val)
202 +
203 + // no need to quote tokens
204 + if (TOKEN_REGEXP.test(str)) {
205 + return str
206 + }
207 +
208 + if (str.length > 0 && !TEXT_REGEXP.test(str)) {
209 + throw new TypeError('invalid parameter value')
210 + }
211 +
212 + return '"' + str.replace(QUOTE_REGEXP, '\\$1') + '"'
213 +}
214 +
215 +/**
216 + * Class to represent a content type.
217 + * @private
218 + */
219 +function ContentType (type) {
220 + this.parameters = Object.create(null)
221 + this.type = type
222 +}
1 +{
2 + "name": "content-type",
3 + "description": "Create and parse HTTP Content-Type header",
4 + "version": "1.0.4",
5 + "author": "Douglas Christopher Wilson <doug@somethingdoug.com>",
6 + "license": "MIT",
7 + "keywords": [
8 + "content-type",
9 + "http",
10 + "req",
11 + "res",
12 + "rfc7231"
13 + ],
14 + "repository": "jshttp/content-type",
15 + "devDependencies": {
16 + "eslint": "3.19.0",
17 + "eslint-config-standard": "10.2.1",
18 + "eslint-plugin-import": "2.7.0",
19 + "eslint-plugin-node": "5.1.1",
20 + "eslint-plugin-promise": "3.5.0",
21 + "eslint-plugin-standard": "3.0.1",
22 + "istanbul": "0.4.5",
23 + "mocha": "~1.21.5"
24 + },
25 + "files": [
26 + "LICENSE",
27 + "HISTORY.md",
28 + "README.md",
29 + "index.js"
30 + ],
31 + "engines": {
32 + "node": ">= 0.6"
33 + },
34 + "scripts": {
35 + "lint": "eslint .",
36 + "test": "mocha --reporter spec --check-leaks --bail test/",
37 + "test-ci": "istanbul cover node_modules/mocha/bin/_mocha --report lcovonly -- --reporter spec --check-leaks test/",
38 + "test-cov": "istanbul cover node_modules/mocha/bin/_mocha -- --reporter dot --check-leaks test/"
39 + }
40 +}
1 +1.4.6 / 2021-11-16
2 +==================
3 +
4 + * deps: cookie@0.4.1
5 +
6 +1.4.5 / 2020-03-14
7 +==================
8 +
9 + * deps: cookie@0.4.0
10 +
11 +1.4.4 / 2019-02-12
12 +==================
13 +
14 + * perf: normalize `secret` argument only once
15 +
16 +1.4.3 / 2016-05-26
17 +==================
18 +
19 + * deps: cookie@0.3.1
20 + - perf: use for loop in parse
21 +
22 +1.4.2 / 2016-05-20
23 +==================
24 +
25 + * deps: cookie@0.2.4
26 + - perf: enable strict mode
27 + - perf: use for loop in parse
28 + - perf: use string concatenation for serialization
29 +
30 +1.4.1 / 2016-01-11
31 +==================
32 +
33 + * deps: cookie@0.2.3
34 + * perf: enable strict mode
35 +
36 +1.4.0 / 2015-09-18
37 +==================
38 +
39 + * Accept array of secrets in addition to a single secret
40 + * Fix `JSONCookie` to return `undefined` for non-string arguments
41 + * Fix `signedCookie` to return `undefined` for non-string arguments
42 + * deps: cookie@0.2.2
43 +
44 +1.3.5 / 2015-05-19
45 +==================
46 +
47 + * deps: cookie@0.1.3
48 + - Slight optimizations
49 +
50 +1.3.4 / 2015-02-15
51 +==================
52 +
53 + * deps: cookie-signature@1.0.6
54 +
55 +1.3.3 / 2014-09-05
56 +==================
57 +
58 + * deps: cookie-signature@1.0.5
59 +
60 +1.3.2 / 2014-06-26
61 +==================
62 +
63 + * deps: cookie-signature@1.0.4
64 + - fix for timing attacks
65 +
66 +1.3.1 / 2014-06-17
67 +==================
68 +
69 + * actually export `signedCookie`
70 +
71 +1.3.0 / 2014-06-17
72 +==================
73 +
74 + * add `signedCookie` export for single cookie unsigning
75 +
76 +1.2.0 / 2014-06-17
77 +==================
78 +
79 + * export parsing functions
80 + * `req.cookies` and `req.signedCookies` are now plain objects
81 + * slightly faster parsing of many cookies
82 +
83 +1.1.0 / 2014-05-12
84 +==================
85 +
86 + * Support for NodeJS version 0.8
87 + * deps: cookie@0.1.2
88 + - Fix for maxAge == 0
89 + - made compat with expires field
90 + - tweak maxAge NaN error message
91 +
92 +1.0.1 / 2014-02-20
93 +==================
94 +
95 + * add missing dependencies
96 +
97 +1.0.0 / 2014-02-15
98 +==================
99 +
100 + * Genesis from `connect`
1 +(The MIT License)
2 +
3 +Copyright (c) 2014 TJ Holowaychuk <tj@vision-media.ca>
4 +Copyright (c) 2015 Douglas Christopher Wilson <doug@somethingdoug.com>
5 +
6 +Permission is hereby granted, free of charge, to any person obtaining
7 +a copy of this software and associated documentation files (the
8 +'Software'), to deal in the Software without restriction, including
9 +without limitation the rights to use, copy, modify, merge, publish,
10 +distribute, sublicense, and/or sell copies of the Software, and to
11 +permit persons to whom the Software is furnished to do so, subject to
12 +the following conditions:
13 +
14 +The above copyright notice and this permission notice shall be
15 +included in all copies or substantial portions of the Software.
16 +
17 +THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
18 +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19 +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
20 +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
21 +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
22 +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
23 +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
1 +# cookie-parser
2 +
3 +[![NPM Version][npm-version-image]][npm-url]
4 +[![NPM Downloads][npm-downloads-image]][npm-url]
5 +[![Build Status][ci-image]][ci-url]
6 +[![Test Coverage][coveralls-image]][coveralls-url]
7 +
8 +Parse `Cookie` header and populate `req.cookies` with an object keyed by the
9 +cookie names. Optionally you may enable signed cookie support by passing a
10 +`secret` string, which assigns `req.secret` so it may be used by other
11 +middleware.
12 +
13 +## Installation
14 +
15 +```sh
16 +$ npm install cookie-parser
17 +```
18 +
19 +## API
20 +
21 +```js
22 +var cookieParser = require('cookie-parser')
23 +```
24 +
25 +### cookieParser(secret, options)
26 +
27 +Create a new cookie parser middleware function using the given `secret` and
28 +`options`.
29 +
30 +- `secret` a string or array used for signing cookies. This is optional and if
31 + not specified, will not parse signed cookies. If a string is provided, this
32 + is used as the secret. If an array is provided, an attempt will be made to
33 + unsign the cookie with each secret in order.
34 +- `options` an object that is passed to `cookie.parse` as the second option. See
35 + [cookie](https://www.npmjs.org/package/cookie) for more information.
36 + - `decode` a function to decode the value of the cookie
37 +
38 +The middleware will parse the `Cookie` header on the request and expose the
39 +cookie data as the property `req.cookies` and, if a `secret` was provided, as
40 +the property `req.signedCookies`. These properties are name value pairs of the
41 +cookie name to cookie value.
42 +
43 +When `secret` is provided, this module will unsign and validate any signed cookie
44 +values and move those name value pairs from `req.cookies` into `req.signedCookies`.
45 +A signed cookie is a cookie that has a value prefixed with `s:`. Signed cookies
46 +that fail signature validation will have the value `false` instead of the tampered
47 +value.
48 +
49 +In addition, this module supports special "JSON cookies". These are cookie where
50 +the value is prefixed with `j:`. When these values are encountered, the value will
51 +be exposed as the result of `JSON.parse`. If parsing fails, the original value will
52 +remain.
53 +
54 +### cookieParser.JSONCookie(str)
55 +
56 +Parse a cookie value as a JSON cookie. This will return the parsed JSON value
57 +if it was a JSON cookie, otherwise, it will return the passed value.
58 +
59 +### cookieParser.JSONCookies(cookies)
60 +
61 +Given an object, this will iterate over the keys and call `JSONCookie` on each
62 +value, replacing the original value with the parsed value. This returns the
63 +same object that was passed in.
64 +
65 +### cookieParser.signedCookie(str, secret)
66 +
67 +Parse a cookie value as a signed cookie. This will return the parsed unsigned
68 +value if it was a signed cookie and the signature was valid. If the value was
69 +not signed, the original value is returned. If the value was signed but the
70 +signature could not be validated, `false` is returned.
71 +
72 +The `secret` argument can be an array or string. If a string is provided, this
73 +is used as the secret. If an array is provided, an attempt will be made to
74 +unsign the cookie with each secret in order.
75 +
76 +### cookieParser.signedCookies(cookies, secret)
77 +
78 +Given an object, this will iterate over the keys and check if any value is a
79 +signed cookie. If it is a signed cookie and the signature is valid, the key
80 +will be deleted from the object and added to the new object that is returned.
81 +
82 +The `secret` argument can be an array or string. If a string is provided, this
83 +is used as the secret. If an array is provided, an attempt will be made to
84 +unsign the cookie with each secret in order.
85 +
86 +## Example
87 +
88 +```js
89 +var express = require('express')
90 +var cookieParser = require('cookie-parser')
91 +
92 +var app = express()
93 +app.use(cookieParser())
94 +
95 +app.get('/', function (req, res) {
96 + // Cookies that have not been signed
97 + console.log('Cookies: ', req.cookies)
98 +
99 + // Cookies that have been signed
100 + console.log('Signed Cookies: ', req.signedCookies)
101 +})
102 +
103 +app.listen(8080)
104 +
105 +// curl command that sends an HTTP request with two cookies
106 +// curl http://127.0.0.1:8080 --cookie "Cho=Kim;Greet=Hello"
107 +```
108 +
109 +## License
110 +
111 +[MIT](LICENSE)
112 +
113 +[ci-image]: https://badgen.net/github/checks/expressjs/cookie-parser/master?label=ci
114 +[ci-url]: https://github.com/expressjs/cookie-parser/actions?query=workflow%3Aci
115 +[coveralls-image]: https://badgen.net/coveralls/c/github/expressjs/cookie-parser/master
116 +[coveralls-url]: https://coveralls.io/r/expressjs/cookie-parser?branch=master
117 +[npm-downloads-image]: https://badgen.net/npm/dm/cookie-parser
118 +[npm-url]: https://npmjs.org/package/cookie-parser
119 +[npm-version-image]: https://badgen.net/npm/v/cookie-parser
1 +/*!
2 + * cookie-parser
3 + * Copyright(c) 2014 TJ Holowaychuk
4 + * Copyright(c) 2015 Douglas Christopher Wilson
5 + * MIT Licensed
6 + */
7 +
8 +'use strict'
9 +
10 +/**
11 + * Module dependencies.
12 + * @private
13 + */
14 +
15 +var cookie = require('cookie')
16 +var signature = require('cookie-signature')
17 +
18 +/**
19 + * Module exports.
20 + * @public
21 + */
22 +
23 +module.exports = cookieParser
24 +module.exports.JSONCookie = JSONCookie
25 +module.exports.JSONCookies = JSONCookies
26 +module.exports.signedCookie = signedCookie
27 +module.exports.signedCookies = signedCookies
28 +
29 +/**
30 + * Parse Cookie header and populate `req.cookies`
31 + * with an object keyed by the cookie names.
32 + *
33 + * @param {string|array} [secret] A string (or array of strings) representing cookie signing secret(s).
34 + * @param {Object} [options]
35 + * @return {Function}
36 + * @public
37 + */
38 +
39 +function cookieParser (secret, options) {
40 + var secrets = !secret || Array.isArray(secret)
41 + ? (secret || [])
42 + : [secret]
43 +
44 + return function cookieParser (req, res, next) {
45 + if (req.cookies) {
46 + return next()
47 + }
48 +
49 + var cookies = req.headers.cookie
50 +
51 + req.secret = secrets[0]
52 + req.cookies = Object.create(null)
53 + req.signedCookies = Object.create(null)
54 +
55 + // no cookies
56 + if (!cookies) {
57 + return next()
58 + }
59 +
60 + req.cookies = cookie.parse(cookies, options)
61 +
62 + // parse signed cookies
63 + if (secrets.length !== 0) {
64 + req.signedCookies = signedCookies(req.cookies, secrets)
65 + req.signedCookies = JSONCookies(req.signedCookies)
66 + }
67 +
68 + // parse JSON cookies
69 + req.cookies = JSONCookies(req.cookies)
70 +
71 + next()
72 + }
73 +}
74 +
75 +/**
76 + * Parse JSON cookie string.
77 + *
78 + * @param {String} str
79 + * @return {Object} Parsed object or undefined if not json cookie
80 + * @public
81 + */
82 +
83 +function JSONCookie (str) {
84 + if (typeof str !== 'string' || str.substr(0, 2) !== 'j:') {
85 + return undefined
86 + }
87 +
88 + try {
89 + return JSON.parse(str.slice(2))
90 + } catch (err) {
91 + return undefined
92 + }
93 +}
94 +
95 +/**
96 + * Parse JSON cookies.
97 + *
98 + * @param {Object} obj
99 + * @return {Object}
100 + * @public
101 + */
102 +
103 +function JSONCookies (obj) {
104 + var cookies = Object.keys(obj)
105 + var key
106 + var val
107 +
108 + for (var i = 0; i < cookies.length; i++) {
109 + key = cookies[i]
110 + val = JSONCookie(obj[key])
111 +
112 + if (val) {
113 + obj[key] = val
114 + }
115 + }
116 +
117 + return obj
118 +}
119 +
120 +/**
121 + * Parse a signed cookie string, return the decoded value.
122 + *
123 + * @param {String} str signed cookie string
124 + * @param {string|array} secret
125 + * @return {String} decoded value
126 + * @public
127 + */
128 +
129 +function signedCookie (str, secret) {
130 + if (typeof str !== 'string') {
131 + return undefined
132 + }
133 +
134 + if (str.substr(0, 2) !== 's:') {
135 + return str
136 + }
137 +
138 + var secrets = !secret || Array.isArray(secret)
139 + ? (secret || [])
140 + : [secret]
141 +
142 + for (var i = 0; i < secrets.length; i++) {
143 + var val = signature.unsign(str.slice(2), secrets[i])
144 +
145 + if (val !== false) {
146 + return val
147 + }
148 + }
149 +
150 + return false
151 +}
152 +
153 +/**
154 + * Parse signed cookies, returning an object containing the decoded key/value
155 + * pairs, while removing the signed key from obj.
156 + *
157 + * @param {Object} obj
158 + * @param {string|array} secret
159 + * @return {Object}
160 + * @public
161 + */
162 +
163 +function signedCookies (obj, secret) {
164 + var cookies = Object.keys(obj)
165 + var dec
166 + var key
167 + var ret = Object.create(null)
168 + var val
169 +
170 + for (var i = 0; i < cookies.length; i++) {
171 + key = cookies[i]
172 + val = obj[key]
173 + dec = signedCookie(val, secret)
174 +
175 + if (val !== dec) {
176 + ret[key] = dec
177 + delete obj[key]
178 + }
179 + }
180 +
181 + return ret
182 +}
1 +{
2 + "name": "cookie-parser",
3 + "description": "Parse HTTP request cookies",
4 + "version": "1.4.6",
5 + "author": "TJ Holowaychuk <tj@vision-media.ca> (http://tjholowaychuk.com)",
6 + "contributors": [
7 + "Douglas Christopher Wilson <doug@somethingdoug.com>"
8 + ],
9 + "license": "MIT",
10 + "repository": "expressjs/cookie-parser",
11 + "keywords": [
12 + "cookie",
13 + "middleware"
14 + ],
15 + "dependencies": {
16 + "cookie": "0.4.1",
17 + "cookie-signature": "1.0.6"
18 + },
19 + "devDependencies": {
20 + "eslint": "7.32.0",
21 + "eslint-config-standard": "14.1.1",
22 + "eslint-plugin-import": "2.25.2",
23 + "eslint-plugin-markdown": "2.2.1",
24 + "eslint-plugin-node": "11.1.0",
25 + "eslint-plugin-promise": "4.3.1",
26 + "eslint-plugin-standard": "4.1.0",
27 + "mocha": "9.1.3",
28 + "nyc": "15.1.0",
29 + "supertest": "6.1.6"
30 + },
31 + "files": [
32 + "LICENSE",
33 + "HISTORY.md",
34 + "index.js"
35 + ],
36 + "engines": {
37 + "node": ">= 0.8.0"
38 + },
39 + "scripts": {
40 + "lint": "eslint .",
41 + "test": "mocha --reporter spec --bail --check-leaks test/",
42 + "test-ci": "nyc --reporter=lcov --reporter=text npm test",
43 + "test-cov": "nyc --reporter=html --reporter=text npm test"
44 + }
45 +}
1 +support
2 +test
3 +examples
4 +*.sock
1 +1.0.6 / 2015-02-03
2 +==================
3 +
4 +* use `npm test` instead of `make test` to run tests
5 +* clearer assertion messages when checking input
6 +
7 +
8 +1.0.5 / 2014-09-05
9 +==================
10 +
11 +* add license to package.json
12 +
13 +1.0.4 / 2014-06-25
14 +==================
15 +
16 + * corrected avoidance of timing attacks (thanks @tenbits!)
17 +
18 +1.0.3 / 2014-01-28
19 +==================
20 +
21 + * [incorrect] fix for timing attacks
22 +
23 +1.0.2 / 2014-01-28
24 +==================
25 +
26 + * fix missing repository warning
27 + * fix typo in test
28 +
29 +1.0.1 / 2013-04-15
30 +==================
31 +
32 + * Revert "Changed underlying HMAC algo. to sha512."
33 + * Revert "Fix for timing attacks on MAC verification."
34 +
35 +0.0.1 / 2010-01-03
36 +==================
37 +
38 + * Initial release
1 +
2 +# cookie-signature
3 +
4 + Sign and unsign cookies.
5 +
6 +## Example
7 +
8 +```js
9 +var cookie = require('cookie-signature');
10 +
11 +var val = cookie.sign('hello', 'tobiiscool');
12 +val.should.equal('hello.DGDUkGlIkCzPz+C0B064FNgHdEjox7ch8tOBGslZ5QI');
13 +
14 +var val = cookie.sign('hello', 'tobiiscool');
15 +cookie.unsign(val, 'tobiiscool').should.equal('hello');
16 +cookie.unsign(val, 'luna').should.be.false;
17 +```
18 +
19 +## License
20 +
21 +(The MIT License)
22 +
23 +Copyright (c) 2012 LearnBoost &lt;tj@learnboost.com&gt;
24 +
25 +Permission is hereby granted, free of charge, to any person obtaining
26 +a copy of this software and associated documentation files (the
27 +'Software'), to deal in the Software without restriction, including
28 +without limitation the rights to use, copy, modify, merge, publish,
29 +distribute, sublicense, and/or sell copies of the Software, and to
30 +permit persons to whom the Software is furnished to do so, subject to
31 +the following conditions:
32 +
33 +The above copyright notice and this permission notice shall be
34 +included in all copies or substantial portions of the Software.
35 +
36 +THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
37 +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
38 +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
39 +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
40 +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
41 +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
42 +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
...\ No newline at end of file ...\ No newline at end of file
1 +/**
2 + * Module dependencies.
3 + */
4 +
5 +var crypto = require('crypto');
6 +
7 +/**
8 + * Sign the given `val` with `secret`.
9 + *
10 + * @param {String} val
11 + * @param {String} secret
12 + * @return {String}
13 + * @api private
14 + */
15 +
16 +exports.sign = function(val, secret){
17 + if ('string' != typeof val) throw new TypeError("Cookie value must be provided as a string.");
18 + if ('string' != typeof secret) throw new TypeError("Secret string must be provided.");
19 + return val + '.' + crypto
20 + .createHmac('sha256', secret)
21 + .update(val)
22 + .digest('base64')
23 + .replace(/\=+$/, '');
24 +};
25 +
26 +/**
27 + * Unsign and decode the given `val` with `secret`,
28 + * returning `false` if the signature is invalid.
29 + *
30 + * @param {String} val
31 + * @param {String} secret
32 + * @return {String|Boolean}
33 + * @api private
34 + */
35 +
36 +exports.unsign = function(val, secret){
37 + if ('string' != typeof val) throw new TypeError("Signed cookie string must be provided.");
38 + if ('string' != typeof secret) throw new TypeError("Secret string must be provided.");
39 + var str = val.slice(0, val.lastIndexOf('.'))
40 + , mac = exports.sign(str, secret);
41 +
42 + return sha1(mac) == sha1(val) ? str : false;
43 +};
44 +
45 +/**
46 + * Private
47 + */
48 +
49 +function sha1(str){
50 + return crypto.createHash('sha1').update(str).digest('hex');
51 +}
1 +{
2 + "name": "cookie-signature",
3 + "version": "1.0.6",
4 + "description": "Sign and unsign cookies",
5 + "keywords": ["cookie", "sign", "unsign"],
6 + "author": "TJ Holowaychuk <tj@learnboost.com>",
7 + "license": "MIT",
8 + "repository": { "type": "git", "url": "https://github.com/visionmedia/node-cookie-signature.git"},
9 + "dependencies": {},
10 + "devDependencies": {
11 + "mocha": "*",
12 + "should": "*"
13 + },
14 + "scripts": {
15 + "test": "mocha --require should --reporter spec"
16 + },
17 + "main": "index"
18 +}
1 +0.4.1 / 2020-04-21
2 +==================
3 +
4 + * Fix `maxAge` option to reject invalid values
5 +
6 +0.4.0 / 2019-05-15
7 +==================
8 +
9 + * Add `SameSite=None` support
10 +
11 +0.3.1 / 2016-05-26
12 +==================
13 +
14 + * Fix `sameSite: true` to work with draft-7 clients
15 + - `true` now sends `SameSite=Strict` instead of `SameSite`
16 +
17 +0.3.0 / 2016-05-26
18 +==================
19 +
20 + * Add `sameSite` option
21 + - Replaces `firstPartyOnly` option, never implemented by browsers
22 + * Improve error message when `encode` is not a function
23 + * Improve error message when `expires` is not a `Date`
24 +
25 +0.2.4 / 2016-05-20
26 +==================
27 +
28 + * perf: enable strict mode
29 + * perf: use for loop in parse
30 + * perf: use string concatination for serialization
31 +
32 +0.2.3 / 2015-10-25
33 +==================
34 +
35 + * Fix cookie `Max-Age` to never be a floating point number
36 +
37 +0.2.2 / 2015-09-17
38 +==================
39 +
40 + * Fix regression when setting empty cookie value
41 + - Ease the new restriction, which is just basic header-level validation
42 + * Fix typo in invalid value errors
43 +
44 +0.2.1 / 2015-09-17
45 +==================
46 +
47 + * Throw on invalid values provided to `serialize`
48 + - Ensures the resulting string is a valid HTTP header value
49 +
50 +0.2.0 / 2015-08-13
51 +==================
52 +
53 + * Add `firstPartyOnly` option
54 + * Throw better error for invalid argument to parse
55 + * perf: hoist regular expression
56 +
57 +0.1.5 / 2015-09-17
58 +==================
59 +
60 + * Fix regression when setting empty cookie value
61 + - Ease the new restriction, which is just basic header-level validation
62 + * Fix typo in invalid value errors
63 +
64 +0.1.4 / 2015-09-17
65 +==================
66 +
67 + * Throw better error for invalid argument to parse
68 + * Throw on invalid values provided to `serialize`
69 + - Ensures the resulting string is a valid HTTP header value
70 +
71 +0.1.3 / 2015-05-19
72 +==================
73 +
74 + * Reduce the scope of try-catch deopt
75 + * Remove argument reassignments
76 +
77 +0.1.2 / 2014-04-16
78 +==================
79 +
80 + * Remove unnecessary files from npm package
81 +
82 +0.1.1 / 2014-02-23
83 +==================
84 +
85 + * Fix bad parse when cookie value contained a comma
86 + * Fix support for `maxAge` of `0`
87 +
88 +0.1.0 / 2013-05-01
89 +==================
90 +
91 + * Add `decode` option
92 + * Add `encode` option
93 +
94 +0.0.6 / 2013-04-08
95 +==================
96 +
97 + * Ignore cookie parts missing `=`
98 +
99 +0.0.5 / 2012-10-29
100 +==================
101 +
102 + * Return raw cookie value if value unescape errors
103 +
104 +0.0.4 / 2012-06-21
105 +==================
106 +
107 + * Use encode/decodeURIComponent for cookie encoding/decoding
108 + - Improve server/client interoperability
109 +
110 +0.0.3 / 2012-06-06
111 +==================
112 +
113 + * Only escape special characters per the cookie RFC
114 +
115 +0.0.2 / 2012-06-01
116 +==================
117 +
118 + * Fix `maxAge` option to not throw error
119 +
120 +0.0.1 / 2012-05-28
121 +==================
122 +
123 + * Add more tests
124 +
125 +0.0.0 / 2012-05-28
126 +==================
127 +
128 + * Initial release
1 +(The MIT License)
2 +
3 +Copyright (c) 2012-2014 Roman Shtylman <shtylman@gmail.com>
4 +Copyright (c) 2015 Douglas Christopher Wilson <doug@somethingdoug.com>
5 +
6 +Permission is hereby granted, free of charge, to any person obtaining
7 +a copy of this software and associated documentation files (the
8 +'Software'), to deal in the Software without restriction, including
9 +without limitation the rights to use, copy, modify, merge, publish,
10 +distribute, sublicense, and/or sell copies of the Software, and to
11 +permit persons to whom the Software is furnished to do so, subject to
12 +the following conditions:
13 +
14 +The above copyright notice and this permission notice shall be
15 +included in all copies or substantial portions of the Software.
16 +
17 +THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
18 +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19 +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
20 +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
21 +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
22 +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
23 +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24 +
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff could not be displayed because it is too large.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff could not be displayed because it is too large.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.
This diff is collapsed. Click to expand it.